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