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

1.1       www         1: # The LearningOnline Network with CAPA
                      2: # Localization routines
                      3: #
1.44    ! raeburn     4: # $Id: lonlocal.pm,v 1.43 2008/01/29 13:26:09 www 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.1       www       168: 
                    169: require Exporter;
                    170: 
                    171: our @ISA = qw (Exporter);
1.22      bowersj2  172: our @EXPORT = qw(mt mtn ns);
1.1       www       173: 
                    174: # ========================================================= The language handle
                    175: 
                    176: use vars qw($lh);
                    177: 
                    178: # ===================================================== The "MakeText" function
                    179: 
                    180: sub mt (@) {
1.36      albertel  181: #    open(LOG,'>>/home/www/loncapa/loncom/localize/localize/newphrases.txt');
                    182: #    print LOG (@_[0]."\n");
                    183: #    close(LOG);
1.26      www       184:     if ($lh) {
1.44    ! raeburn   185:         if ($_[0] eq '') {
        !           186:             if (wantarray) {
        !           187:                 return @_;
        !           188:             } else {
        !           189:                 return $_[0];
        !           190:             }
        !           191:         } else {
        !           192:             return $lh->maketext(@_);
        !           193:         }
1.3       www       194:     } else {
1.31      albertel  195: 	if (wantarray) {
                    196: 	    return @_;
                    197: 	} else {
                    198: 	    return $_[0];
                    199: 	}
1.4       www       200:     }
                    201: }
                    202: 
1.6       www       203: # ============================================================== What language?
                    204: 
                    205: sub current_language {
1.20      albertel  206:     if ($lh) {
                    207: 	my $lang=$lh->maketext('language_code');
                    208: 	return ($lang eq 'language_code'?'en':$lang);
                    209:     }
1.21      www       210:     return 'en';
1.6       www       211: }
                    212: 
1.8       www       213: # ============================================================== What encoding?
                    214: 
                    215: sub current_encoding {
1.33      albertel  216:     my $default='UTF-8';
                    217:     if ($Apache::lonnet::env{'browser.os'} eq 'win' && 
                    218: 	$Apache::lonnet::env{'browser.type'} eq 'explorer') {
1.34      albertel  219:         $default='ISO-8859-1';
1.33      albertel  220:     }
1.12      albertel  221:     if ($lh) {
                    222: 	my $enc=$lh->maketext('char_encoding');
1.33      albertel  223: 	return ($enc eq 'char_encoding'?$default:$enc);
1.12      albertel  224:     } else {
1.33      albertel  225: 	return $default;
1.12      albertel  226:     }
1.8       www       227: }
                    228: 
1.15      www       229: # =============================================================== Which locale?
                    230: # Refer to locale -a
                    231: #
                    232: sub current_locale {
                    233:     if ($lh) {
                    234: 	my $enc=$lh->maketext('lang_locale');
                    235: 	return ($enc eq 'lang_locale'?'':$enc);
                    236:     } else {
                    237: 	return undef;
                    238:     }
                    239: }
                    240: 
1.4       www       241: # ============================================================== Translate hash
                    242: 
                    243: sub texthash {
                    244:     my %hash=@_;
                    245:     foreach (keys %hash) {
                    246: 	$hash{$_}=&mt($hash{$_});
                    247:     }
                    248:     return %hash;
1.1       www       249: }
                    250: 
                    251: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
                    252: 
                    253: sub get_language_handle {
1.9       www       254:     my $r=shift;
1.31      albertel  255:     if ($r) {
                    256: 	my $headers=$r->headers_in;
                    257: 	$ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
                    258:     }
1.29      www       259:     my @languages=&Apache::loncommon::preferred_languages;
                    260:     $ENV{'HTTP_ACCEPT_LANGUAGE'}='';
                    261:     $lh=Apache::localize->get_handle(@languages);
1.37      albertel  262:     if ($r) {
1.12      albertel  263: 	$r->content_languages([&current_language()]);
1.8       www       264:     }
1.16      www       265: ###    setlocale(LC_ALL,&current_locale);
1.18      www       266: }
                    267: 
                    268: # ========================================================== Localize localtime
1.35      www       269: sub gettimezone {
1.39      albertel  270:     my ($time) = @_;
1.42      albertel  271:     if ($Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'}) {
                    272: 	return $Apache::lonnet::env{'course.'.$Apache::lonnet::env{'request.course.id'}.'.timezone'};
                    273:     }
                    274:     return 'local';
1.35      www       275: }
1.18      www       276: 
                    277: sub locallocaltime {
                    278:     my $thistime=shift;
1.40      albertel  279:     if (!defined($thistime) || $thistime eq '') {
                    280: 	return &mt('Never');
                    281:     }
1.42      albertel  282: 
                    283:     my $dt = DateTime->from_epoch(epoch => $thistime)
                    284:                      ->set_time_zone(&gettimezone());
1.18      www       285:     if ((&current_language=~/^en/) || (!$lh)) {
1.42      albertel  286: 
                    287: 	return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
1.18      www       288:     } else {
                    289: 	my $format=$lh->maketext('date_locale');
                    290: 	if ($format eq 'date_locale') {
1.42      albertel  291: 	    return $dt->strftime("%a %b %e %I:%M:%S %P %Y (%Z)");
1.18      www       292: 	}
1.42      albertel  293: 	my $time_zone  = $dt->time_zone_short_name();
                    294: 	my $seconds    = $dt->second();
                    295: 	my $minutes    = $dt->minute();
                    296: 	my $twentyfour = $dt->hour();
                    297: 	my $day        = $dt->day_of_month();
                    298: 	my $mon        = $dt->month()-1;
                    299: 	my $year       = $dt->year();
1.43      www       300: 	my $wday       = $dt->wday();
                    301:         if ($wday==7) { $wday=0; }
1.42      albertel  302: 	my $month  =(split(/\,/,$lh->maketext('date_months')))[$mon];
1.18      www       303: 	my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
                    304: 	if ($seconds<10) {
                    305: 	    $seconds='0'.$seconds;
                    306: 	}
                    307: 	if ($minutes<10) {
                    308: 	    $minutes='0'.$minutes;
                    309: 	}
                    310: 	my $twelve=$twentyfour;
1.19      www       311: 	my $ampm;
1.18      www       312: 	if ($twelve>12) {
                    313: 	    $twelve-=12;
1.19      www       314: 	    $ampm=$lh->maketext('date_pm');
1.18      www       315: 	} else {
1.19      www       316: 	    $ampm=$lh->maketext('date_am');
1.18      www       317: 	}
1.42      albertel  318: 	foreach ('seconds','minutes','twentyfour','twelve','day','year',
                    319: 		 'month','weekday','ampm') {
1.18      www       320: 	    $format=~s/\$$_/eval('$'.$_)/gse;
                    321: 	}
1.42      albertel  322: 	return $format." ($time_zone)";
1.18      www       323:     }
1.1       www       324: }
                    325: 
1.17      bowersj2  326: # ==================== Normalize string (reduce fragility in the lexicon files)
                    327: 
                    328: # This normalizes a string to reduce fragility in the lexicon files of
                    329: # huge messages (such as are used by the helper), and allow useful
                    330: # formatting: reduce all consecutive whitespace to a single space,
                    331: # and remove all HTML
                    332: sub normalize_string {
                    333:     my $s = shift;
                    334:     $s =~ s/\s+/ /g;
                    335:     $s =~ s/<[^>]+>//g;
1.22      bowersj2  336:     # Pop off beginning or ending spaces, which aren't good
                    337:     $s =~ s/^\s+//;
                    338:     $s =~ s/\s+$//;
1.17      bowersj2  339:     return $s;
                    340: }
1.22      bowersj2  341: 
                    342: # alias for normalize_string; recommend using it only in the lexicon
                    343: sub ns {
                    344:     return normalize_string(@_);
                    345: }
                    346: 
                    347: # mtn: call the mt function and the normalization function easily.
                    348: # Returns original non-normalized string if there was no translation
                    349: sub mtn (@) {
                    350:     my @args = @_; # don't want to modify caller's string; if we
                    351: 		   # didn't care about that we could set $_[0]
                    352: 		   # directly
                    353:     $args[0] = normalize_string($args[0]);
                    354:     my $translation = &mt(@args);
                    355:     if ($translation ne $args[0]) {
                    356: 	return $translation;
                    357:     } else {
                    358: 	return $_[0];
                    359:     }
1.27      www       360: }
                    361: 
                    362: # ---------------------------------------------------- Replace MT{...} in files
                    363: 
                    364: sub transstatic {
                    365:     my $strptr=shift;
                    366:     $$strptr=~s/MT\{([^\}]*)\}/&mt($1)/gse;
                    367: }
                    368: 
1.41      albertel  369: =pod 
                    370: 
                    371: =item * mt_escape
                    372: 
                    373: mt_escape takes a string reference and escape the [] in there so mt
                    374: will leave them as is and not try to expand them
                    375: 
                    376: =cut
                    377: 
                    378: sub mt_escape {
                    379:     my ($str_ref) = @_;
                    380:     $$str_ref =~s/~/~~/g;
                    381:     $$str_ref =~s/([\[\]])/~$1/g;
                    382: }
                    383: 
1.1       www       384: 1;
                    385: 
                    386: __END__

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