Annotation of loncom/localize/lonlocal.pm, revision 1.31
1.1 www 1: # The LearningOnline Network with CAPA
2: # Localization routines
3: #
1.31 ! albertel 4: # $Id: lonlocal.pm,v 1.30 2003/12/22 23:42:18 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;
1.27 www 164: use Apache::Constants qw(:common);
1.1 www 165: use Apache::localize;
1.3 www 166: use Apache::File;
1.14 www 167: use locale;
168: use POSIX qw(locale_h);
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.23 www 182: # my $fh=Apache::File->new('>>/home/www/loncapa/loncom/localize/localize/newphrases.txt');
1.26 www 183: # print $fh @_[0]."\n";
1.23 www 184: # $fh->close();
1.26 www 185: if ($lh) {
186: return $lh->maketext(@_);
1.3 www 187: } else {
1.31 ! albertel 188: if (wantarray) {
! 189: return @_;
! 190: } else {
! 191: return $_[0];
! 192: }
1.4 www 193: }
194: }
195:
1.6 www 196: # ============================================================== What language?
197:
198: sub current_language {
1.20 albertel 199: if ($lh) {
200: my $lang=$lh->maketext('language_code');
201: return ($lang eq 'language_code'?'en':$lang);
202: }
1.21 www 203: return 'en';
1.6 www 204: }
205:
1.8 www 206: # ============================================================== What encoding?
207:
208: sub current_encoding {
1.12 albertel 209: if ($lh) {
210: my $enc=$lh->maketext('char_encoding');
211: return ($enc eq 'char_encoding'?'':$enc);
212: } else {
213: return undef;
214: }
1.8 www 215: }
216:
1.15 www 217: # =============================================================== Which locale?
218: # Refer to locale -a
219: #
220: sub current_locale {
221: if ($lh) {
222: my $enc=$lh->maketext('lang_locale');
223: return ($enc eq 'lang_locale'?'':$enc);
224: } else {
225: return undef;
226: }
227: }
228:
1.4 www 229: # ============================================================== Translate hash
230:
231: sub texthash {
232: my %hash=@_;
233: foreach (keys %hash) {
234: $hash{$_}=&mt($hash{$_});
235: }
236: return %hash;
1.1 www 237: }
238:
239: # ========= Get a handle (do not invoke in vain, leave this to access handlers)
240:
241: sub get_language_handle {
1.9 www 242: my $r=shift;
1.31 ! albertel 243: if ($r) {
! 244: my $headers=$r->headers_in;
! 245: $ENV{'HTTP_ACCEPT_LANGUAGE'}=$headers->{'Accept-language'};
! 246: }
1.29 www 247: my @languages=&Apache::loncommon::preferred_languages;
248: $ENV{'HTTP_ACCEPT_LANGUAGE'}='';
249: $lh=Apache::localize->get_handle(@languages);
1.31 ! albertel 250: if ($r && &Apache::lonnet::mod_perl_version == 1) {
1.12 albertel 251: $r->content_languages([¤t_language()]);
1.8 www 252: }
1.16 www 253: ### setlocale(LC_ALL,¤t_locale);
1.18 www 254: }
255:
256: # ========================================================== Localize localtime
257:
258: sub locallocaltime {
259: my $thistime=shift;
260: if ((¤t_language=~/^en/) || (!$lh)) {
261: return ''.localtime($thistime);
262: } else {
263: my $format=$lh->maketext('date_locale');
264: if ($format eq 'date_locale') {
265: return ''.localtime($thistime);
266: }
267: my ($seconds,$minutes,$twentyfour,$day,$mon,$year,$wday,$yday,$isdst)=
268: localtime($thistime);
269: my $month=(split(/\,/,$lh->maketext('date_months')))[$mon];
270: my $weekday=(split(/\,/,$lh->maketext('date_days')))[$wday];
271: if ($seconds<10) {
272: $seconds='0'.$seconds;
273: }
274: if ($minutes<10) {
275: $minutes='0'.$minutes;
276: }
277: $year+=1900;
278: my $twelve=$twentyfour;
1.19 www 279: my $ampm;
1.18 www 280: if ($twelve>12) {
281: $twelve-=12;
1.19 www 282: $ampm=$lh->maketext('date_pm');
1.18 www 283: } else {
1.19 www 284: $ampm=$lh->maketext('date_am');
1.18 www 285: }
286: foreach
287: ('seconds','minutes','twentyfour','twelve','day','year',
1.19 www 288: 'month','weekday','ampm') {
1.18 www 289: $format=~s/\$$_/eval('$'.$_)/gse;
290: }
291: return $format;
292: }
1.1 www 293: }
294:
1.17 bowersj2 295: # ==================== Normalize string (reduce fragility in the lexicon files)
296:
297: # This normalizes a string to reduce fragility in the lexicon files of
298: # huge messages (such as are used by the helper), and allow useful
299: # formatting: reduce all consecutive whitespace to a single space,
300: # and remove all HTML
301: sub normalize_string {
302: my $s = shift;
303: $s =~ s/\s+/ /g;
304: $s =~ s/<[^>]+>//g;
1.22 bowersj2 305: # Pop off beginning or ending spaces, which aren't good
306: $s =~ s/^\s+//;
307: $s =~ s/\s+$//;
1.17 bowersj2 308: return $s;
309: }
1.22 bowersj2 310:
311: # alias for normalize_string; recommend using it only in the lexicon
312: sub ns {
313: return normalize_string(@_);
314: }
315:
316: # mtn: call the mt function and the normalization function easily.
317: # Returns original non-normalized string if there was no translation
318: sub mtn (@) {
319: my @args = @_; # don't want to modify caller's string; if we
320: # didn't care about that we could set $_[0]
321: # directly
322: $args[0] = normalize_string($args[0]);
323: my $translation = &mt(@args);
324: if ($translation ne $args[0]) {
325: return $translation;
326: } else {
327: return $_[0];
328: }
1.27 www 329: }
330:
331: # ---------------------------------------------------- Replace MT{...} in files
332:
333: sub transstatic {
334: my $strptr=shift;
335: $$strptr=~s/MT\{([^\}]*)\}/&mt($1)/gse;
336: }
337:
338: # ----------------------------------------------- Handler Routine /adm/localize
339: sub handler {
340: my $r=shift;
341: &Apache::lonlocal::get_language_handle($r);
342: &Apache::loncommon::content_type($r,'text/html');
343: $r->send_http_header;
344: return OK if $r->header_only;
345:
346: my $uri=$r->uri;
347: $uri=~s/^\/adm\/localize//;
348: my $fn=$Apache::lonnet::perlvar{'lonDocRoot'}.$uri;
349:
350: my $file=&Apache::lonnet::getfile($fn);
351: &transstatic(\$file);
352: $r->print($file);
353: return OK;
1.22 bowersj2 354: }
355:
1.1 www 356: 1;
357:
358: __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