SL/Locale.pm

   1 #====================================================================
   2 # LX-Office ERP
   3 # Copyright (C) 2004
   4 # Based on SQL-Ledger Version 2.1.9
   5 # Web http://www.lx-office.org
   6 #
   7 #=====================================================================
   8 # SQL-Ledger Accounting
   9 # Copyright (C) 1998-2002
  10 #
  11 #  Author: Dieter Simader
  12 #   Email: dsimader@sql-ledger.org
  13 #     Web: http://www.sql-ledger.org
  14 #
  15 # Contributors: Thomas Bayen <bayen@gmx.de>
  16 #               Antti Kaihola <akaihola@siba.fi>
  17 #               Moritz Bunkus (tex code)
  18 #
  19 # This program is free software; you can redistribute it and/or modify
  20 # it under the terms of the GNU General Public License as published by
  21 # the Free Software Foundation; either version 2 of the License, or
  22 # (at your option) any later version.
  23 #
  24 # This program is distributed in the hope that it will be useful,
  25 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  26 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27 # GNU General Public License for more details.
  28 # You should have received a copy of the GNU General Public License
  29 # along with this program; if not, write to the Free Software
  30 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  31 #======================================================================
  32 #
  33 # Translations and number/date formatting
  34 #
  35 #======================================================================
  36
  37 package Locale;
  38
  39 use DateTime;
  40 use Encode;
  41 use List::Util qw(first);
  42 use List::MoreUtils qw(any);
  43
  44 use SL::LXDebug;
  45 use SL::Common;
  46 use SL::Iconv;
  47 use SL::Inifile;
  48
  49 use strict;
  50
  51 my %locales_by_country;
  52
  53 sub new {
  54   $main::lxdebug->enter_sub();
  55
  56   my ($type, $country) = @_;
  57
  58   $country ||= $::lx_office_conf{system}->{language};
  59   $country   =~ s|.*/||;
  60   $country   =~ s|\.||g;
  61
  62   if (!$locales_by_country{$country}) {
  63     my $self = {};
  64     bless $self, $type;
  65
  66     $self->_init($country);
  67
  68     $locales_by_country{$country} = $self;
  69   }
  70
  71   $main::lxdebug->leave_sub();
  72
  73   return $locales_by_country{$country}
  74 }
  75
  76 sub _init {
  77   my $self     = shift;
  78   my $country  = shift;
  79
  80   $self->{charset}     = Common::DEFAULT_CHARSET;
  81   $self->{countrycode} = $country;
  82
  83   if ($country && -d "locale/$country") {
  84     local *IN;
  85     if (open(IN, "<", "locale/$country/all")) {
  86       my $code = join("", <IN>);
  87       eval($code);
  88       close(IN);
  89     }
  90
  91     if (open IN, "<", "locale/$country/charset") {
  92       $self->{charset} = <IN>;
  93       close IN;
  94
  95       chomp $self->{charset};
  96     }
  97   }
  98
  99   my $db_charset            = $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET;
 100   $self->{is_utf8}          = (any { lc($::lx_office_conf{system}->{dbcharset} || '') eq $_ } qw(utf8 utf-8 unicode)) ? 1 : 0;
 101
 102   if ($self->{is_utf8}) {
 103     binmode STDOUT, ":utf8";
 104     binmode STDERR, ":utf8";
 105   }
 106
 107   $self->{iconv}            = SL::Iconv->new($self->{charset}, $db_charset);
 108   $self->{iconv_reverse}    = SL::Iconv->new($db_charset,      $self->{charset});
 109   $self->{iconv_english}    = SL::Iconv->new('ASCII',          $db_charset);
 110   $self->{iconv_iso8859}    = SL::Iconv->new('ISO-8859-15',    $db_charset);
 111   $self->{iconv_to_iso8859} = SL::Iconv->new($db_charset,      'ISO-8859-15');
 112   $self->{iconv_utf8}       = SL::Iconv->new('UTF-8',          $db_charset);
 113
 114   $self->_read_special_chars_file($country);
 115
 116   push @{ $self->{LONG_MONTH} },
 117     ("January",   "February", "March",    "April",
 118      "May ",      "June",     "July",     "August",
 119      "September", "October",  "November", "December");
 120   push @{ $self->{SHORT_MONTH} },
 121     (qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec));
 122 }
 123
 124 sub is_utf8 {
 125   my $self   = shift;
 126   my $handle = shift;
 127   return $self->{is_utf8} && (!$handle || $handle->is_utf8);
 128 }
 129
 130 sub _handle_markup {
 131   my $self    = shift;
 132   my $str     = shift;
 133
 134   my $escaped = 0;
 135   my $new_str = '';
 136
 137   for (my $i = 0; $i < length $str; $i++) {
 138     my $char = substr $str, $i, 1;
 139
 140     if ($escaped) {
 141       if ($char eq 'n') {
 142         $new_str .= "\n";
 143
 144       } elsif ($char eq 'r') {
 145         $new_str .= "\r";
 146
 147       } elsif ($char eq 's') {
 148         $new_str .= ' ';
 149
 150       } elsif ($char eq 'x') {
 151         $new_str .= chr(hex(substr($str, $i + 1, 2)));
 152         $i       += 2;
 153
 154       } else {
 155         $new_str .= $char;
 156       }
 157
 158       $escaped  = 0;
 159
 160     } elsif ($char eq '\\') {
 161       $escaped  = 1;
 162
 163     } else {
 164       $new_str .= $char;
 165     }
 166   }
 167
 168   return $new_str;
 169 }
 170
 171 sub _read_special_chars_file {
 172   my $self    = shift;
 173   my $country = shift;
 174
 175   if (! -f "locale/$country/special_chars") {
 176     $self->{special_chars_map} = {};
 177     return;
 178   }
 179
 180   $self->{special_chars_map} = Inifile->new("locale/$country/special_chars", 'verbatim' => 1);
 181
 182   foreach my $format (keys %{ $self->{special_chars_map} }) {
 183     next if (($format eq 'FILE') || ($format eq 'ORDER') || (ref $self->{special_chars_map}->{$format} ne 'HASH'));
 184
 185     if ($format ne lc $format) {
 186       $self->{special_chars_map}->{lc $format} = $self->{special_chars_map}->{$format};
 187       delete $self->{special_chars_map}->{$format};
 188       $format = lc $format;
 189     }
 190
 191     my $scmap = $self->{special_chars_map}->{$format};
 192     my $order = $self->{iconv}->convert($scmap->{order});
 193     delete $scmap->{order};
 194
 195     foreach my $key (keys %{ $scmap }) {
 196       $scmap->{$key} = $self->_handle_markup($self->{iconv}->convert($scmap->{$key}));
 197
 198       my $new_key    = $self->_handle_markup($self->{iconv}->convert($key));
 199
 200       if ($key ne $new_key) {
 201         $scmap->{$new_key} = $scmap->{$key};
 202         delete $scmap->{$key};
 203       }
 204     }
 205
 206     $self->{special_chars_map}->{"${format}-reverse"}          = { reverse %{ $scmap } };
 207
 208     $scmap->{order}                                            = [ map { $self->_handle_markup($_) } split m/\s+/, $order ];
 209     $self->{special_chars_map}->{"${format}-reverse"}->{order} = [ grep { $_ } map { $scmap->{$_} } reverse @{ $scmap->{order} } ];
 210   }
 211 }
 212
 213 sub text {
 214   my $self = shift;
 215   my $text = shift;
 216
 217   if ($self->{texts}->{$text}) {
 218     $text = $self->{iconv}->convert($self->{texts}->{$text});
 219   } else {
 220     $text = $self->{iconv_english}->convert($text);
 221   }
 222
 223   if (@_) {
 224     $text = Form->format_string($text, @_);
 225   }
 226
 227   return $text;
 228 }
 229
 230 sub findsub {
 231   $main::lxdebug->enter_sub();
 232
 233   my ($self, $text) = @_;
 234   my $text_rev      = lc $self->{iconv_reverse}->convert($text);
 235   $text_rev         =~ s/[\s\-]+/_/g;
 236
 237   if (!$self->{texts_reverse}) {
 238     $self->{texts_reverse} = { };
 239     while (my ($original, $translation) = each %{ $self->{texts} }) {
 240       $original    =  lc $original;
 241       $original    =~ s/[^a-z0-9]/_/g;
 242       $original    =~ s/_+/_/g;
 243
 244       $translation =  lc $translation;
 245       $translation =~ s/[\s\-]+/_/g;
 246
 247       $self->{texts_reverse}->{$translation} ||= [ ];
 248       push @{ $self->{texts_reverse}->{$translation} }, $original;
 249     }
 250   }
 251
 252   my $sub_name;
 253   $sub_name   = first { defined(&{ "::${_}" }) } @{ $self->{texts_reverse}->{$text_rev} } if $self->{texts_reverse}->{$text_rev};
 254   $sub_name ||= $text_rev if ($text_rev =~ m/^[a-z][a-z0-9_]+$/) && defined &{ "::${text_rev}" };
 255
 256   $main::form->error("$text not defined in locale/$self->{countrycode}/all") if !$sub_name;
 257
 258   $main::lxdebug->leave_sub();
 259
 260   return $sub_name;
 261 }
 262
 263 sub date {
 264   $main::lxdebug->enter_sub();
 265
 266   my ($self, $myconfig, $date, $longformat) = @_;
 267
 268   my $longdate  = "";
 269   my $longmonth = ($longformat) ? 'LONG_MONTH' : 'SHORT_MONTH';
 270
 271   my ($spc, $yy, $mm, $dd);
 272
 273   if ($date) {
 274
 275     # get separator
 276     $spc = $myconfig->{dateformat};
 277     $spc =~ s/\w//g;
 278     $spc = substr($spc, 1, 1);
 279
 280     if ($date =~ /\D/) {
 281       if ($myconfig->{dateformat} =~ /^yy/) {
 282         ($yy, $mm, $dd) = split /\D/, $date;
 283       }
 284       if ($myconfig->{dateformat} =~ /^mm/) {
 285         ($mm, $dd, $yy) = split /\D/, $date;
 286       }
 287       if ($myconfig->{dateformat} =~ /^dd/) {
 288         ($dd, $mm, $yy) = split /\D/, $date;
 289       }
 290     } else {
 291       $date = substr($date, 2);
 292       ($yy, $mm, $dd) = ($date =~ /(..)(..)(..)/);
 293     }
 294
 295     $dd *= 1;
 296     $mm--;
 297     $yy = ($yy < 70) ? $yy + 2000 : $yy;
 298     $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
 299
 300     if ($myconfig->{dateformat} =~ /^dd/) {
 301       if (defined $longformat && $longformat == 0) {
 302         $mm++;
 303         $dd = "0$dd" if ($dd < 10);
 304         $mm = "0$mm" if ($mm < 10);
 305         $longdate = "$dd$spc$mm$spc$yy";
 306       } else {
 307         $longdate = "$dd";
 308         $longdate .= ($spc eq '.') ? ". " : " ";
 309         $longdate .= &text($self, $self->{$longmonth}[$mm]) . " $yy";
 310       }
 311     } elsif ($myconfig->{dateformat} eq "yyyy-mm-dd") {
 312
 313       # Use German syntax with the ISO date style "yyyy-mm-dd" because
 314       # Lx-Office is mainly used in Germany or German speaking countries.
 315       if (defined $longformat && $longformat == 0) {
 316         $mm++;
 317         $dd = "0$dd" if ($dd < 10);
 318         $mm = "0$mm" if ($mm < 10);
 319         $longdate = "$yy-$mm-$dd";
 320       } else {
 321         $longdate = "$dd. ";
 322         $longdate .= &text($self, $self->{$longmonth}[$mm]) . " $yy";
 323       }
 324     } else {
 325       if (defined $longformat && $longformat == 0) {
 326         $mm++;
 327         $dd = "0$dd" if ($dd < 10);
 328         $mm = "0$mm" if ($mm < 10);
 329         $longdate = "$mm$spc$dd$spc$yy";
 330       } else {
 331         $longdate = &text($self, $self->{$longmonth}[$mm]) . " $dd, $yy";
 332       }
 333     }
 334
 335   }
 336
 337   $main::lxdebug->leave_sub();
 338
 339   return $longdate;
 340 }
 341
 342 sub parse_date {
 343   $main::lxdebug->enter_sub();
 344
 345   my ($self, $myconfig, $date, $longformat) = @_;
 346   my ($spc, $yy, $mm, $dd);
 347
 348   unless ($date) {
 349     $main::lxdebug->leave_sub();
 350     return ();
 351   }
 352
 353   # get separator
 354   $spc = $myconfig->{dateformat};
 355   $spc =~ s/\w//g;
 356   $spc = substr($spc, 1, 1);
 357
 358   if ($date =~ /\D/) {
 359     if ($myconfig->{dateformat} =~ /^yy/) {
 360       ($yy, $mm, $dd) = split /\D/, $date;
 361     } elsif ($myconfig->{dateformat} =~ /^mm/) {
 362       ($mm, $dd, $yy) = split /\D/, $date;
 363     } elsif ($myconfig->{dateformat} =~ /^dd/) {
 364       ($dd, $mm, $yy) = split /\D/, $date;
 365     }
 366   } else {
 367     $date = substr($date, 2);
 368     ($yy, $mm, $dd) = ($date =~ /(..)(..)(..)/);
 369   }
 370
 371   $dd *= 1;
 372   $mm *= 1;
 373   $yy = ($yy < 70) ? $yy + 2000 : $yy;
 374   $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
 375
 376   $main::lxdebug->leave_sub();
 377   return ($yy, $mm, $dd);
 378 }
 379
 380 sub parse_date_to_object {
 381   my $self           = shift;
 382   my ($yy, $mm, $dd) = $self->parse_date(@_);
 383
 384   return $yy && $mm && $dd ? DateTime->new(year => $yy, month => $mm, day => $dd) : undef;
 385 }
 386
 387 sub reformat_date {
 388   $main::lxdebug->enter_sub();
 389
 390   my ($self, $myconfig, $date, $output_format, $longformat) = @_;
 391
 392   $main::lxdebug->leave_sub() and return "" unless ($date);
 393
 394   my ($yy, $mm, $dd) = $self->parse_date($myconfig, $date);
 395
 396   $output_format =~ /d+/;
 397   substr($output_format, $-[0], $+[0] - $-[0]) =
 398     sprintf("%0" . (length($&)) . "d", $dd);
 399
 400   $output_format =~ /m+/;
 401   substr($output_format, $-[0], $+[0] - $-[0]) =
 402     sprintf("%0" . (length($&)) . "d", $mm);
 403
 404   $output_format =~ /y+/;
 405   substr($output_format, $-[0], $+[0] - $-[0]) = $yy;
 406
 407   $main::lxdebug->leave_sub();
 408
 409   return $output_format;
 410 }
 411
 412 sub format_date {
 413   $main::lxdebug->enter_sub();
 414
 415   my $self     = shift;
 416   my $myconfig = shift;
 417   my $yy       = shift;
 418   my $mm       = shift;
 419   my $dd       = shift;
 420   my $yy_len   = shift || 4;
 421
 422   ($yy, $mm, $dd) = ($yy->year, $yy->month, $yy->day) if ref $yy eq 'DateTime';
 423
 424   $main::lxdebug->leave_sub() and return "" unless $yy && $mm && $dd;
 425
 426   $yy = $yy % 100 if 2 == $yy_len;
 427
 428   my $format = ref $myconfig eq '' ? "$myconfig" : $myconfig->{dateformat};
 429   $format =~ s{ d+ }{ sprintf("%0" . (length($&)) . "d", $dd) }gex;
 430   $format =~ s{ m+ }{ sprintf("%0" . (length($&)) . "d", $mm) }gex;
 431   $format =~ s{ y+ }{ sprintf("%0${yy_len}d",            $yy) }gex;
 432
 433   $main::lxdebug->leave_sub();
 434
 435   return $format;
 436 }
 437
 438 sub quote_special_chars {
 439   my $self   = shift;
 440   my $format = lc shift;
 441   my $string = shift;
 442
 443   if ($self->{special_chars_map} && $self->{special_chars_map}->{$format} && $self->{special_chars_map}->{$format}->{order}) {
 444     my $scmap = $self->{special_chars_map}->{$format};
 445
 446     map { $string =~ s/\Q${_}\E/$scmap->{$_}/g } @{ $scmap->{order} };
 447   }
 448
 449   return $string;
 450 }
 451
 452 sub unquote_special_chars {
 453   my $self    = shift;
 454   my $format  = shift;
 455
 456   return $self->quote_special_chars("${format}-reverse", shift);
 457 }
 458
 459 sub remap_special_chars {
 460   my $self       = shift;
 461   my $src_format = shift;
 462   my $dst_format = shift;
 463
 464   return $self->quote_special_chars($dst_format, $self->quote_special_chars("${src_format}-reverse", shift));
 465 }
 466
 467 sub raw_io_active {
 468   my $self = shift;
 469
 470   return !!$self->{raw_io_active};
 471 }
 472
 473 sub with_raw_io {
 474   my $self = shift;
 475   my $fh   = shift;
 476   my $code = shift;
 477
 478   $self->{raw_io_active} = 1;
 479   binmode $fh, ":raw";
 480   $code->();
 481   binmode $fh, ":utf8" if $self->is_utf8;
 482   $self->{raw_io_active} = 0;
 483 }
 484
 485 sub set_numberformat_wo_thousands_separator {
 486   my $self     = shift;
 487   my $myconfig = shift || \%::myconfig;
 488
 489   $self->{saved_numberformat} = $myconfig->{numberformat};
 490   $myconfig->{numberformat}   =~ s/^1[,\.]/1/;
 491 }
 492
 493 sub restore_numberformat {
 494   my $self     = shift;
 495   my $myconfig = shift || \%::myconfig;
 496
 497   $myconfig->{numberformat} = $self->{saved_numberformat} if $self->{saved_numberformat};
 498 }
 499
 500 sub get_local_time_zone {
 501   my $self = shift;
 502   $self->{local_time_zone} ||= DateTime::TimeZone->new(name => 'local');
 503   return $self->{local_time_zone};
 504 }
 505
 506 1;