[BACK]Return to lonlocal.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / localize

Diff for /loncom/localize/lonlocal.pm between versions 1.62 and 1.68

version 1.62, 2011/03/28 21:10:41 version 1.68, 2020/10/29 23:04:39
Line 38  Apache::lonlocal - provides localization Line 38  Apache::lonlocal - provides localization
   
 lonlocal provides localization services for LON-CAPA programmers based  lonlocal provides localization services for LON-CAPA programmers based
 on Locale::Maketext. See  on Locale::Maketext. See
 C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>  C<https://metacpan.org/pod/Locale::Maketext>
 for more information on Maketext.  for more information on Maketext.
   
 =head1 OVERVIEWX<internationalization>  =head1 OVERVIEWX<internationalization>
Line 81  Inside might be something like this Line 81  Inside might be something like this
      if ($status eq 'WON') {       if ($status eq 'WON') {
         $message='You have won.';          $message='You have won.';
      } elsif ($status eq 'LOST') {       } elsif ($status eq 'LOST') {
         $message='You are a total looser.';          $message='You are a total loser.';
      }       }
      return $message;       return $message;
  }   }
Line 103  The first two examples are easy: Line 103  The first two examples are easy:
      if ($status eq 'WON') {       if ($status eq 'WON') {
         $message='You have won.';          $message='You have won.';
      } elsif ($status eq 'LOST') {       } elsif ($status eq 'LOST') {
         $message='You are a total looser.';          $message='You are a total loser.';
      }       }
      return &mt($message);       return &mt($message);
  }   }
Line 135  like this: Line 135  like this:
     'You have won.'      'You have won.'
  => 'Sie haben gewonnen.',   => 'Sie haben gewonnen.',
   
     'You are a total looser.'      'You are a total loser.'
  => 'Sie sind der totale Verlierer.',   => 'Sie sind der totale Verlierer.',
   
     'Rules'      'Rules'
Line 153  ignore the rest of the line. Line 153  ignore the rest of the line.
 This is a relatively easy task, and any help is appreciated.  This is a relatively easy task, and any help is appreciated.
   
 Maketext can do a whole lot more, see  Maketext can do a whole lot more, see
 C<http://search.cpan.org/dist/Locale-Maketext/lib/Locale/Maketext.pod>  C<https://metacpan.org/pod/Locale::Maketext>
 but for most purposes, we do not have to mess with that.  but for most purposes, we do not have to mess with that.
   
 =cut  =cut
Line 171  use DateTime::Locale; Line 171  use DateTime::Locale;
 require Exporter;  require Exporter;
   
 our @ISA = qw (Exporter);  our @ISA = qw (Exporter);
 our @EXPORT = qw(mt mtn ns mt_user);  our @EXPORT = qw(mt mtn ns mt_user js_escape html_escape);
   
 my %mtcache=();  my %mtcache=();
   
Line 264  sub preferred_languages { Line 264  sub preferred_languages {
   
     my $defdom = &Apache::lonnet::default_login_domain();      my $defdom = &Apache::lonnet::default_login_domain();
     foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'},$defdom) {      foreach my $domtype ($Apache::lonnet::env{'user.domain'},$Apache::lonnet::env{'request.role.domain'},$defdom) {
         if ($domtype ne '') {          if (($domtype ne '') && ($domtype ne 'public')) {
             my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);              my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
             if ($domdefs{'lang_def'} ne '') {              if ($domdefs{'lang_def'} ne '') {
                 push(@languages,$domdefs{'lang_def'});                  push(@languages,$domdefs{'lang_def'});
Line 325  sub current_locale { Line 325  sub current_locale {
   
 sub texthash {  sub texthash {
     my %hash=@_;      my %hash=@_;
     foreach (keys %hash) {      foreach (keys(%hash)) {
  $hash{$_}=&mt($hash{$_});   $hash{$_}=&mt($hash{$_});
     }      }
     return %hash;      return %hash;
Line 382  sub gettimezone { Line 382  sub gettimezone {
         if ($uroledomdefs{'timezone_def'} ne '') {          if ($uroledomdefs{'timezone_def'} ne '') {
             $timezone = $uroledomdefs{'timezone_def'};              $timezone = $uroledomdefs{'timezone_def'};
         }          }
     } elsif ($Apache::lonnet::env{'user.domain'} ne '') {      } elsif (($Apache::lonnet::env{'user.domain'} ne '') && 
                ($Apache::lonnet::env{'user.domain'} ne 'public')) {
         my %udomdefaults =           my %udomdefaults = 
             &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});              &Apache::lonnet::get_domain_defaults($Apache::lonnet::env{'user.domain'});
         if ($udomdefaults{'timezone_def'} ne '') {          if ($udomdefaults{'timezone_def'} ne '') {
Line 495  sub getdatelocale { Line 496  sub getdatelocale {
     return $locale_obj;      return $locale_obj;
 }  }
   
 =pod   =pod
   
   =over 
   
 =item * normalize_string  =item * normalize_string()
   
 Normalize string (reduce fragility in the lexicon files)  Normalize string (reduce fragility in the lexicon files)
   
Line 520  sub normalize_string { Line 523  sub normalize_string {
   
 =pod   =pod 
   
 =item * ns  =item * ns()
   
 alias for normalize_string; recommend using it only in the lexicon  alias for normalize_string; recommend using it only in the lexicon
   
Line 532  sub ns { Line 535  sub ns {
   
 =pod  =pod
   
 =item * mtn  =item * mtn()
   
 mtn: call the mt function and the normalization function easily.  mtn: call the mt function and the normalization function easily.
 Returns original non-normalized string if there was no translation  Returns original non-normalized string if there was no translation
Line 561  sub transstatic { Line 564  sub transstatic {
   
 =pod   =pod 
   
 =item * mt_escape  =item * mt_escape()
   
 mt_escape takes a string reference and escape the [] in there so mt  mt_escape takes a string reference and escape the [] in there so mt
 will leave them as is and not try to expand them  will leave them as is and not try to expand them
Line 574  sub mt_escape { Line 577  sub mt_escape {
     $$str_ref =~s/([\[\]])/~$1/g;      $$str_ref =~s/([\[\]])/~$1/g;
 }  }
   
   =pod 
   
   =item * js_escape()
   
   js_escape takes a string, string reference or hash reference,
   and escapes the values so that they can be used within a <script> element.
   It replaces all instances of \ by \\, ' by \', " by \" and \n by \\n.
   It is typically used with localized strings, which might contain quotes.
   
   =cut
   
   sub js_escape {
       my ($v) = @_;
       my $ref = ref($v);
       if ($ref eq 'SCALAR') {
           $$v =~ s/\\/\\\\/g;
           $$v =~ s/'/\\'/g;
           $$v =~ s/"/\\"/g;
           $$v =~ s/\n/\\n/g;
       } elsif ($ref eq 'HASH') {
           foreach my $key (keys %$v) {
               $v->{$key} =~ s/\\/\\\\/g;
               $v->{$key} =~ s/'/\\'/g;
               $v->{$key} =~ s/"/\\"/g;
               $v->{$key} =~ s/\n/\\n/g;
           }
       } else {
           $v =~ s/\\/\\\\/g;
           $v =~ s/'/\\'/g;
           $v =~ s/"/\\"/g;
           $v =~ s/\n/\\n/g;
           return $v;
       }
   }
   
   =pod 
   
   =item * html_escape()
   
   html_escape takes a string, string reference or hash reference,
   and escapes the values so that they can be used as HTML.
   It encodes <, >, &, ' and ".
   
   =cut
   
   sub html_escape {
       my ($v) = @_;
       my $ref = ref($v);
       if ($ref eq 'SCALAR') {
           $$v =~ s/&/&amp;/g;
           $$v =~ s/</&lt;/g;
           $$v =~ s/>/&gt;/g;
           $$v =~ s/'/&apos;/g;
           $$v =~ s/"/&quot;/g;
       } elsif ($ref eq 'HASH') {
           foreach my $key (keys %$v) {
               $v->{$key} =~ s/&/&amp;/g;
               $v->{$key} =~ s/</&lt;/g;
               $v->{$key} =~ s/>/&gt;/g;
               $v->{$key} =~ s/'/&apos;/g;
               $v->{$key} =~ s/"/&quot;/g;
           }
       } else {
           $v =~ s/&/&amp;/g;
           $v =~ s/</&lt;/g;
           $v =~ s/>/&gt;/g;
           $v =~ s/'/&apos;/g;
           $v =~ s/"/&quot;/g;
           return $v;
       }
       # NOTE: we could also turn \n into <br> if needed
   }
   
 =pod  =pod
   
 =item * choose_language  =item * choose_language()
   
 choose_language prompts a user to enter a two letter language code via  choose_language prompts a user to enter a two letter language code via
 keyboard when running a script from the command line. Default is en.  keyboard when running a script from the command line. Default is en.
   
   =back
   
 =cut  =cut
   
 sub choose_language {  sub choose_language {
Removed from v.1.62  
changed lines
  Added in v.1.68

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