Return to lonlocal.pm CVS log

Up to [LON-CAPA] / loncom / localize

Bug #2248: enable locale-dependent rendering of dates.

    1: # The LearningOnline Network with CAPA
    2: # Localization routines
    3: #
    4: # $Id: lonlocal.pm,v 1.18 2003/10/04 18:13:36 www 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 Apache::File;
  166: use locale;
  167: use POSIX qw(locale_h);
  168: 
  169: require Exporter;
  170: 
  171: our @ISA = qw (Exporter);
  172: our @EXPORT = qw(mt);
  173: 
  174: my $reroute;
  175: 
  176: # ========================================================= The language handle
  177: 
  178: use vars qw($lh);
  179: 
  180: # ===================================================== The "MakeText" function
  181: 
  182: sub mt (@) {
  183:     unless ($ENV{'environment.translator'}) {
  184: 	if ($lh) {
  185: 	    return $lh->maketext(@_);
  186: 	} else {
  187: 	    return @_;
  188: 	}
  189:     } else {
  190: 	if ($lh) {
  191: 	    my $trans=$lh->maketext(@_);
  192: 	    my $link='<a target="trans" href="/cgi-bin/translator.pl?arg1='.
  193: 		&Apache::lonnet::escape($_[0]).'&arg2='.
  194: 		&Apache::lonnet::escape($_[1]).'&arg3='.
  195: 		&Apache::lonnet::escape($_[2]).'&lang='.
  196: 		$ENV{'environment.translator'}.
  197: 		'">[['.$trans.']]</a>';
  198: 	    if ($ENV{'transreroute'}) {
  199: 		$reroute.=$link;
  200: 		return $trans;
  201: 	    } else {
  202: 		return $link;
  203: 	    }
  204: 	} else {
  205: 	    return @_;
  206: 	}
  207:     }
  208: }
  209: 
  210: # ============================================================== What language?
  211: 
  212: sub current_language {
  213:     my $lang=$lh->maketext('language_code');
  214:     return ($lang eq 'language_code'?'en':$lang);
  215: }
  216: 
  217: # ============================================================== What encoding?
  218: 
  219: sub current_encoding {
  220:     if ($lh) {
  221: 	my $enc=$lh->maketext('char_encoding');
  222: 	return ($enc eq 'char_encoding'?'':$enc);
  223:     } else {
  224: 	return undef;
  225:     }
  226: }
  227: 
  228: # =============================================================== Which locale?
  229: # Refer to locale -a
  230: #
  231: sub current_locale {
  232:     if ($lh) {
  233: 	my $enc=$lh->maketext('lang_locale');
  234: 	return ($enc eq 'lang_locale'?'':$enc);
  235:     } else {
  236: 	return undef;
  237:     }
  238: }
  239: 
  240: # ============================================================== Translate hash
  241: 
  242: sub texthash {
  243:     my %hash=@_;
  244:     foreach (keys %hash) {
  245: 	$hash{$_}=&mt($hash{$_});
  246:     }
  247:     return %hash;
  248: }
  249: # ======================================================== Re-route translation
  250: 
  251: sub clearreroutetrans {
  252:     &reroutetrans();
  253:     $reroute='';
  254: }
  255: 
  256: # ======================================================== Re-route translation
  257: 
  258: sub reroutetrans {
  259:     $ENV{'transreroute'}=1;
  260: }
  261: 
  262: # ==================================================== End re-route translation
  263: sub endreroutetrans {
  264:     $ENV{'transreroute'}=0;
  265:     if ($ENV{'environment.translator'}) {
  266: 	return $reroute;
  267:     } else {
  268: 	return '';
  269:     }
  270: }
  271: 
  272: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
  273: 
  274: sub get_language_handle {
  275:     my $r=shift;
  276:     $lh=Apache::localize->get_handle(&Apache::loncommon::preferred_languages);
  277:     if (&Apache::lonnet::mod_perl_version == 1) {
  278: 	$r->content_languages([&current_language()]);
  279:     }
  280: ###    setlocale(LC_ALL,&current_locale);
  281: }
  282: 
  283: # ========================================================== Localize localtime
  284: 
  285: sub locallocaltime {
  286:     my $thistime=shift;
  287:     if ((&current_language=~/^en/) || (!$lh)) {
  288: 	return ''.localtime($thistime);
  289:     } else {
  290: 	my $format=$lh->maketext('date_locale');
  291: 	if ($format eq 'date_locale') {
  292: 	    return ''.localtime($thistime);
  293: 	}
  294: 	my ($seconds,$minutes,$twentyfour,$day,$mon,$year,$wday,$yday,$isdst)=
  295: 	    localtime($thistime);
  296: 	my $month=(split(/\,/,$lh->maketext('date_months')))[$mon];
  297: 	my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
  298: 	if ($seconds<10) {
  299: 	    $seconds='0'.$seconds;
  300: 	}
  301: 	if ($minutes<10) {
  302: 	    $minutes='0'.$minutes;
  303: 	}
  304: 	$year+=1900;
  305: 	my $twelve=$twentyfour;
  306: 	if ($twelve>12) {
  307: 	    $twelve-=12;
  308: 	    $twelve.=$lh->maketext('date_pm');
  309: 	} else {
  310: 	    $twelve.=$lh->maketext('date_am');
  311: 	}
  312: 	foreach 
  313: 	('seconds','minutes','twentyfour','twelve','day','year',
  314: 	 'month','weekday') {
  315: 	    $format=~s/\$$_/eval('$'.$_)/gse;
  316: 	}
  317: 	return $format;
  318:     }
  319: }
  320: 
  321: # ==================== Normalize string (reduce fragility in the lexicon files)
  322: 
  323: # This normalizes a string to reduce fragility in the lexicon files of
  324: # huge messages (such as are used by the helper), and allow useful
  325: # formatting: reduce all consecutive whitespace to a single space,
  326: # and remove all HTML
  327: sub normalize_string {
  328:     my $s = shift;
  329:     $s =~ s/\s+/ /g;
  330:     $s =~ s/<[^>]+>//g;
  331:     return $s;
  332: }
  333: 1;
  334: 
  335: __END__