5c800837ec81a4a184c6efeb2911e00a0b3c91c1
[kivitendo-erp.git] / 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 ||= $::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            = $main::dbcharset || Common::DEFAULT_CHARSET;
100   $self->{is_utf8}          = (any { lc($::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
113   $self->_read_special_chars_file($country);
114
115   push @{ $self->{LONG_MONTH} },
116     ("January",   "February", "March",    "April",
117      "May ",      "June",     "July",     "August",
118      "September", "October",  "November", "December");
119   push @{ $self->{SHORT_MONTH} },
120     (qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec));
121 }
122
123 sub is_utf8 {
124   my $self   = shift;
125   my $handle = shift;
126   return $self->{is_utf8} && (!$handle || $handle->is_utf8);
127 }
128
129 sub _handle_markup {
130   my $self    = shift;
131   my $str     = shift;
132
133   my $escaped = 0;
134   my $new_str = '';
135
136   for (my $i = 0; $i < length $str; $i++) {
137     my $char = substr $str, $i, 1;
138
139     if ($escaped) {
140       if ($char eq 'n') {
141         $new_str .= "\n";
142
143       } elsif ($char eq 'r') {
144         $new_str .= "\r";
145
146       } elsif ($char eq 's') {
147         $new_str .= ' ';
148
149       } elsif ($char eq 'x') {
150         $new_str .= chr(hex(substr($str, $i + 1, 2)));
151         $i       += 2;
152
153       } else {
154         $new_str .= $char;
155       }
156
157       $escaped  = 0;
158
159     } elsif ($char eq '\\') {
160       $escaped  = 1;
161
162     } else {
163       $new_str .= $char;
164     }
165   }
166
167   return $new_str;
168 }
169
170 sub _read_special_chars_file {
171   my $self    = shift;
172   my $country = shift;
173
174   if (! -f "locale/$country/special_chars") {
175     $self->{special_chars_map} = {};
176     return;
177   }
178
179   $self->{special_chars_map} = Inifile->new("locale/$country/special_chars", 'verbatim' => 1);
180
181   foreach my $format (keys %{ $self->{special_chars_map} }) {
182     next if (($format eq 'FILE') || ($format eq 'ORDER') || (ref $self->{special_chars_map}->{$format} ne 'HASH'));
183
184     if ($format ne lc $format) {
185       $self->{special_chars_map}->{lc $format} = $self->{special_chars_map}->{$format};
186       delete $self->{special_chars_map}->{$format};
187       $format = lc $format;
188     }
189
190     my $scmap = $self->{special_chars_map}->{$format};
191     my $order = $self->{iconv}->convert($scmap->{order});
192     delete $scmap->{order};
193
194     foreach my $key (keys %{ $scmap }) {
195       $scmap->{$key} = $self->_handle_markup($self->{iconv}->convert($scmap->{$key}));
196
197       my $new_key    = $self->_handle_markup($self->{iconv}->convert($key));
198
199       if ($key ne $new_key) {
200         $scmap->{$new_key} = $scmap->{$key};
201         delete $scmap->{$key};
202       }
203     }
204
205     $self->{special_chars_map}->{"${format}-reverse"}          = { reverse %{ $scmap } };
206
207     $scmap->{order}                                            = [ map { $self->_handle_markup($_) } split m/\s+/, $order ];
208     $self->{special_chars_map}->{"${format}-reverse"}->{order} = [ grep { $_ } map { $scmap->{$_} } reverse @{ $scmap->{order} } ];
209   }
210 }
211
212 sub text {
213   my $self = shift;
214   my $text = shift;
215
216   if (exists $self->{texts}->{$text}) {
217     $text = $self->{iconv}->convert($self->{texts}->{$text});
218   } else {
219     $text = $self->{iconv_english}->convert($text);
220   }
221
222   if (@_) {
223     $text = Form->format_string($text, @_);
224   }
225
226   return $text;
227 }
228
229 sub findsub {
230   $main::lxdebug->enter_sub();
231
232   my ($self, $text) = @_;
233   my $text_rev      = lc $self->{iconv_reverse}->convert($text);
234
235   if (!$self->{texts_reverse}) {
236     $self->{texts_reverse} = { };
237     while (my ($original, $translation) = each %{ $self->{texts} }) {
238       $original    =  lc $original;
239       $original    =~ s/[^a-z0-9]/_/g;
240       $original    =~ s/_+/_/g;
241
242       $translation =  lc $translation;
243
244       $self->{texts_reverse}->{$translation} ||= [ ];
245       push @{ $self->{texts_reverse}->{$translation} }, $original;
246     }
247   }
248
249   my $sub_name;
250   $sub_name   = first { defined(&{ "::${_}" }) } @{ $self->{texts_reverse}->{$text_rev} } if $self->{texts_reverse}->{$text_rev};
251   $sub_name ||= $text_rev if ($text_rev =~ m/^[a-z][a-z0-9_]+$/) && defined &{ "::${text_rev}" };
252
253   $main::form->error("$text not defined in locale/$self->{countrycode}/all") if !$sub_name;
254
255   $main::lxdebug->leave_sub();
256
257   return $sub_name;
258 }
259
260 sub date {
261   $main::lxdebug->enter_sub();
262
263   my ($self, $myconfig, $date, $longformat) = @_;
264
265   my $longdate  = "";
266   my $longmonth = ($longformat) ? 'LONG_MONTH' : 'SHORT_MONTH';
267
268   my ($spc, $yy, $mm, $dd);
269
270   if ($date) {
271
272     # get separator
273     $spc = $myconfig->{dateformat};
274     $spc =~ s/\w//g;
275     $spc = substr($spc, 1, 1);
276
277     if ($date =~ /\D/) {
278       if ($myconfig->{dateformat} =~ /^yy/) {
279         ($yy, $mm, $dd) = split /\D/, $date;
280       }
281       if ($myconfig->{dateformat} =~ /^mm/) {
282         ($mm, $dd, $yy) = split /\D/, $date;
283       }
284       if ($myconfig->{dateformat} =~ /^dd/) {
285         ($dd, $mm, $yy) = split /\D/, $date;
286       }
287     } else {
288       $date = substr($date, 2);
289       ($yy, $mm, $dd) = ($date =~ /(..)(..)(..)/);
290     }
291
292     $dd *= 1;
293     $mm--;
294     $yy = ($yy < 70) ? $yy + 2000 : $yy;
295     $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
296
297     if ($myconfig->{dateformat} =~ /^dd/) {
298       if (defined $longformat && $longformat == 0) {
299         $mm++;
300         $dd = "0$dd" if ($dd < 10);
301         $mm = "0$mm" if ($mm < 10);
302         $longdate = "$dd$spc$mm$spc$yy";
303       } else {
304         $longdate = "$dd";
305         $longdate .= ($spc eq '.') ? ". " : " ";
306         $longdate .= &text($self, $self->{$longmonth}[$mm]) . " $yy";
307       }
308     } elsif ($myconfig->{dateformat} eq "yyyy-mm-dd") {
309
310       # Use German syntax with the ISO date style "yyyy-mm-dd" because
311       # Lx-Office is mainly used in Germany or German speaking countries.
312       if (defined $longformat && $longformat == 0) {
313         $mm++;
314         $dd = "0$dd" if ($dd < 10);
315         $mm = "0$mm" if ($mm < 10);
316         $longdate = "$yy-$mm-$dd";
317       } else {
318         $longdate = "$dd. ";
319         $longdate .= &text($self, $self->{$longmonth}[$mm]) . " $yy";
320       }
321     } else {
322       if (defined $longformat && $longformat == 0) {
323         $mm++;
324         $dd = "0$dd" if ($dd < 10);
325         $mm = "0$mm" if ($mm < 10);
326         $longdate = "$mm$spc$dd$spc$yy";
327       } else {
328         $longdate = &text($self, $self->{$longmonth}[$mm]) . " $dd, $yy";
329       }
330     }
331
332   }
333
334   $main::lxdebug->leave_sub();
335
336   return $longdate;
337 }
338
339 sub parse_date {
340   $main::lxdebug->enter_sub();
341
342   my ($self, $myconfig, $date, $longformat) = @_;
343   my ($spc, $yy, $mm, $dd);
344
345   unless ($date) {
346     $main::lxdebug->leave_sub();
347     return ();
348   }
349
350   # get separator
351   $spc = $myconfig->{dateformat};
352   $spc =~ s/\w//g;
353   $spc = substr($spc, 1, 1);
354
355   if ($date =~ /\D/) {
356     if ($myconfig->{dateformat} =~ /^yy/) {
357       ($yy, $mm, $dd) = split /\D/, $date;
358     } elsif ($myconfig->{dateformat} =~ /^mm/) {
359       ($mm, $dd, $yy) = split /\D/, $date;
360     } elsif ($myconfig->{dateformat} =~ /^dd/) {
361       ($dd, $mm, $yy) = split /\D/, $date;
362     }
363   } else {
364     $date = substr($date, 2);
365     ($yy, $mm, $dd) = ($date =~ /(..)(..)(..)/);
366   }
367
368   $dd *= 1;
369   $mm *= 1;
370   $yy = ($yy < 70) ? $yy + 2000 : $yy;
371   $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
372
373   $main::lxdebug->leave_sub();
374   return ($yy, $mm, $dd);
375 }
376
377 sub parse_date_to_object {
378   my $self           = shift;
379   my ($yy, $mm, $dd) = $self->parse_date(@_);
380
381   return $yy && $mm && $dd ? DateTime->new(year => $yy, month => $mm, day => $dd) : undef;
382 }
383
384 sub reformat_date {
385   $main::lxdebug->enter_sub();
386
387   my ($self, $myconfig, $date, $output_format, $longformat) = @_;
388
389   $main::lxdebug->leave_sub() and return "" unless ($date);
390
391   my ($yy, $mm, $dd) = $self->parse_date($myconfig, $date);
392
393   $output_format =~ /d+/;
394   substr($output_format, $-[0], $+[0] - $-[0]) =
395     sprintf("%0" . (length($&)) . "d", $dd);
396
397   $output_format =~ /m+/;
398   substr($output_format, $-[0], $+[0] - $-[0]) =
399     sprintf("%0" . (length($&)) . "d", $mm);
400
401   $output_format =~ /y+/;
402   substr($output_format, $-[0], $+[0] - $-[0]) = $yy;
403
404   $main::lxdebug->leave_sub();
405
406   return $output_format;
407 }
408
409 sub format_date {
410   $main::lxdebug->enter_sub();
411
412   my $self     = shift;
413   my $myconfig = shift;
414   my $yy       = shift;
415   my $mm       = shift;
416   my $dd       = shift;
417   my $yy_len   = shift || 4;
418
419   $main::lxdebug->leave_sub() and return "" unless $yy && $mm && $dd;
420
421   $yy = $yy % 100 if 2 == $yy_len;
422
423   my $format = ref $myconfig eq '' ? "$myconfig" : $myconfig->{dateformat};
424   $format =~ s{ d+ }{ sprintf("%0" . (length($&)) . "d", $dd) }gex;
425   $format =~ s{ m+ }{ sprintf("%0" . (length($&)) . "d", $mm) }gex;
426   $format =~ s{ y+ }{ sprintf("%0${yy_len}d",            $yy) }gex;
427
428   $main::lxdebug->leave_sub();
429
430   return $format;
431 }
432
433 sub quote_special_chars {
434   my $self   = shift;
435   my $format = lc shift;
436   my $string = shift;
437
438   if ($self->{special_chars_map} && $self->{special_chars_map}->{$format} && $self->{special_chars_map}->{$format}->{order}) {
439     my $scmap = $self->{special_chars_map}->{$format};
440
441     map { $string =~ s/\Q${_}\E/$scmap->{$_}/g } @{ $scmap->{order} };
442   }
443
444   return $string;
445 }
446
447 sub unquote_special_chars {
448   my $self    = shift;
449   my $format  = shift;
450
451   return $self->quote_special_chars("${format}-reverse", shift);
452 }
453
454 sub remap_special_chars {
455   my $self       = shift;
456   my $src_format = shift;
457   my $dst_format = shift;
458
459   return $self->quote_special_chars($dst_format, $self->quote_special_chars("${src_format}-reverse", shift));
460 }
461
462 sub with_raw_io {
463   my $self = shift;
464   my $fh   = shift;
465   my $code = shift;
466
467   binmode $fh, ":raw";
468   $code->();
469   binmode $fh, ":utf8" if $self->is_utf8;
470 }
471
472 1;