3 # -n do not include custom_ scripts
 
   4 # -v verbose mode, shows progress stuff
 
   6 # this version of locles processes not only all required .pl files
 
   7 # but also all parse_html_templated files.
 
  15 use File::Slurp qw(slurp);
 
  19 use List::Util qw(first);
 
  23 $OUTPUT_AUTOFLUSH = 1;
 
  32 my $basedir      = "../..";
 
  33 my $locales_dir  = ".";
 
  34 my $bindir       = "$basedir/bin/mozilla";
 
  35 my @progdirs     = ( "$basedir/SL" );
 
  36 my $dbupdir      = "$basedir/sql/Pg-upgrade";
 
  37 my $dbupdir2     = "$basedir/sql/Pg-upgrade2";
 
  38 my $menufile     = "menu.ini";
 
  39 my $submitsearch = qr/type\s*=\s*[\"\']?submit/i;
 
  44 my (%referenced_html_files, %locale, %htmllocale, %alllocales, %cached, %submit);
 
  45 my ($ALL_HEADER, $MISSING_HEADER, $LOST_HEADER);
 
  50   my ($top_dir_name) = @_;
 
  57     tie my %dir_h, 'IO::Dir', $dir_name;
 
  59     push @files,   grep { -f } map { "${dir_name}/${_}" }                       keys %dir_h;
 
  60     my @sub_dirs = grep { -d } map { "${dir_name}/${_}" } grep { ! m/^\.\.?$/ } keys %dir_h;
 
  62     $finder->($_) for @sub_dirs;
 
  65   $finder->($top_dir_name);
 
  71 # overwrite existing entries with the ones from 'missing'
 
  72   $self->{texts}->{$_} = $missing->{$_} for grep { $missing->{$_} } keys %alllocales;
 
  74   # try to set missing entries from lost ones
 
  75   my %lost_by_text = map { ($_->{text} => $_->{translation}) } @lost;
 
  76   $self->{texts}->{$_} = $lost_by_text{$_} for grep { !$self->{texts}{$_} } keys %alllocales;
 
  79 my @bindir_files = find_files($bindir);
 
  80 my @progfiles    = map { m:^(.+)/([^/]+)$:; [ $2, $1 ]  } grep { /\.pl$/ && !/_custom/ } @bindir_files;
 
  81 my @customfiles  = grep /_custom/, @bindir_files;
 
  83 push @progfiles, map { m:^(.+)/([^/]+)$:; [ $2, $1 ] } grep { /\.pm$/ } map { find_files($_) } @progdirs;
 
  85 # put customized files into @customfiles
 
  86 my (@menufiles, %dir_h);
 
  90   @menufiles   = ($menufile);
 
  92   tie %dir_h, 'IO::Dir', $basedir;
 
  93   @menufiles = map { "$basedir/$_" } grep { /.*?_$menufile$/ } keys %dir_h;
 
  94   unshift @menufiles, "$basedir/$menufile";
 
  97 tie %dir_h, 'IO::Dir', $dbupdir;
 
  98 my @dbplfiles = grep { /\.pl$/ } keys %dir_h;
 
 100 tie %dir_h, 'IO::Dir', $dbupdir2;
 
 101 my @dbplfiles2 = grep { /\.pl$/ } keys %dir_h;
 
 103 # slurp the translations in
 
 104 if (-f "$locales_dir/all") {
 
 105   require "$locales_dir/all";
 
 107 if (-f "$locales_dir/missing") {
 
 108   require "$locales_dir/missing" ;
 
 109   unlink "$locales_dir/missing";
 
 111 if (-f "$locales_dir/lost") {
 
 112   require "$locales_dir/lost";
 
 113   unlink "$locales_dir/lost";
 
 116 my $charset = slurp("$locales_dir/charset") || 'utf-8';
 
 119 my %old_texts = %{ $self->{texts} || {} };
 
 121 handle_file(@{ $_ })       for @progfiles;
 
 122 handle_file($_, $dbupdir)  for @dbplfiles;
 
 123 handle_file($_, $dbupdir2) for @dbplfiles2;
 
 124 scanmenu($_)               for @menufiles;
 
 126 # merge entries to translate with entries from files 'missing' and 'lost'
 
 131   file      => "$locales_dir/all",
 
 132   header    => $ALL_HEADER,
 
 133   data_name => '$self->{texts}',
 
 134   data_sub  => sub { _print_line($_, $self->{texts}{$_}, @_) for sort keys %alllocales },
 
 137   foreach my $text (keys %$missing) {
 
 138     if ($locale{$text} || $htmllocale{$text}) {
 
 139       unless ($self->{texts}{$text}) {
 
 140         $self->{texts}{$text} = $missing->{$text};
 
 146 # calc and generate missing
 
 147 my @new_missing = grep { !$self->{texts}{$_} } sort keys %alllocales;
 
 151     file      => "$locales_dir/missing",
 
 152     header    => $MISSING_HEADER,
 
 153     data_name => '$missing',
 
 154     data_sub  => sub { _print_line($_, '', @_) for @new_missing },
 
 158 # calc and generate lost
 
 159 while (my ($text, $translation) = each %old_texts) {
 
 160   next if ($alllocales{$text});
 
 161   push @lost, { 'text' => $text, 'translation' => $translation };
 
 165   splice @lost, 0, (scalar @lost - 50) if (scalar @lost > 50);
 
 167     file      => "$locales_dir/lost",
 
 168     header    => $LOST_HEADER,
 
 170     data_name => '@lost',
 
 172       _print_line($_->{text}, $_->{translation}, @_, template => "  { 'text' => %s, 'translation' => %s },\n") for @lost;
 
 177 my $trlanguage = slurp("$locales_dir/LANGUAGE");
 
 180 search_unused_htmlfiles() if $opt_c;
 
 182 my $count  = scalar keys %alllocales;
 
 183 my $notext = scalar @new_missing;
 
 184 my $per    = sprintf("%.1f", ($count - $notext) / $count * 100);
 
 185 print "\n$trlanguage - ${per}%";
 
 186 print " - $notext/$count missing" if $notext;
 
 195 # These are all the texts to build the translations files.
 
 196 # The file has the form of 'english text'  => 'foreign text',
 
 197 # you can add the translation in this file or in the 'missing' file
 
 198 # run locales.pl from this directory to rebuild the translation files
 
 200   $MISSING_HEADER = <<EOL;
 
 201 # add the missing texts and run locales.pl to rebuild
 
 203   $LOST_HEADER  = <<EOL;
 
 204 # The last 50 text strings, that have been removed.
 
 205 # This file has been auto-generated by locales.pl. Please don't edit!
 
 213     'no-custom-files' => \$opt_n,
 
 214     'check-files'     => \$opt_c,
 
 215     'verbose'         => \$opt_v,
 
 227     pod2usage(-exitstatus => 0, -verbose => 2);
 
 232     my $arg = shift @ARGV;
 
 234     foreach my $dir ("../locale/$arg", "locale/$arg", "../$arg", $arg) {
 
 235       next unless -d $dir && -f "$dir/all" && -f "$dir/LANGUAGE";
 
 241       print "The locale directory '$arg' could not be found.\n";
 
 245   } elsif (!-f 'all' || !-f 'LANGUAGE') {
 
 246     print "locales.pl was not called from a locale/* subdirectory,\n"
 
 247       .   "and no locale directory name was given.\n";
 
 253   my ($file, $dir) = @_;
 
 254   print "\n$file" if $opt_v;
 
 258   &scanfile("$dir/$file");
 
 260   # scan custom_{module}.pl or {login}_{module}.pl files
 
 261   foreach my $customfile (@customfiles) {
 
 262     if ($customfile =~ /_$file/) {
 
 263       if (-f "$dir/$customfile") {
 
 264         &scanfile("$dir/$customfile");
 
 272 sub extract_text_between_parenthesis {
 
 273   my ($fh, $line) = @_;
 
 274   my ($inside_string, $pos, $text, $quote_next) = (undef, 0, "", 0);
 
 277     if (length($line) <= $pos) {
 
 279       return ($text, "") unless ($line);
 
 283     my $cur_char = substr($line, $pos, 1);
 
 285     if (!$inside_string) {
 
 286       if ((length($line) >= ($pos + 3)) && (substr($line, $pos, 2)) eq "qq") {
 
 287         $inside_string = substr($line, $pos + 2, 1);
 
 290       } elsif ((length($line) >= ($pos + 2)) &&
 
 291                (substr($line, $pos, 1) eq "q")) {
 
 292         $inside_string = substr($line, $pos + 1, 1);
 
 295       } elsif (($cur_char eq '"') || ($cur_char eq '\'')) {
 
 296         $inside_string = $cur_char;
 
 298       } elsif (($cur_char eq ")") || ($cur_char eq ',')) {
 
 299         return ($text, substr($line, $pos + 1));
 
 304         $text .= '\\' unless $cur_char eq "'";
 
 308       } elsif ($cur_char eq '\\') {
 
 311       } elsif ($cur_char eq $inside_string) {
 
 312         undef($inside_string);
 
 325   my $dont_include_subs = shift;
 
 326   my $scanned_files = shift;
 
 331   $scanned_files = {} unless ($scanned_files);
 
 332   return if ($scanned_files->{$file});
 
 333   $scanned_files->{$file} = 1;
 
 335   if (!defined $cached{$file}) {
 
 337     return unless (-f "$file");
 
 339     my $fh = new FileHandle;
 
 340     open $fh, "$file" or die "$! : $file";
 
 342     my ($is_submit, $line_no, $sub_line_no) = (0, 0, 0);
 
 345       last if /^\s*__END__/;
 
 349       # is this another file
 
 350       if (/require\s+\W.*\.pl/) {
 
 352         $newfile =~ s/require\s+\W//;
 
 353         $newfile =~ s|bin/mozilla||;
 
 354          $cached{$file}{scan}{"$bindir/$newfile"} = 1;
 
 355       } elsif (/use\s+SL::([\w:]*)/) {
 
 358         $cached{$file}{scannosubs}{"../../SL/${module}.pm"} = 1;
 
 361       # is this a template call?
 
 362       if (/(?:parse_html_template2?|render)\s*\(\s*[\"\']([\w\/]+)\s*[\"\']/) {
 
 363         my $newfile = "$basedir/templates/webpages/$1.html";
 
 364         if (/parse_html_template2/) {
 
 365           print "E: " . strip_base($file) . " is still using 'parse_html_template2' for " . strip_base($newfile) . ".\n";
 
 368            $cached{$file}{scanh}{$newfile} = 1;
 
 371           print "W: missing HTML template: " . strip_base($newfile) . " (referenced from " . strip_base($file) . ")\n";
 
 380             my ($null, $country) = split /,/;
 
 381             $country =~ s/^ +[\"\']//;
 
 382             $country =~ s/[\"\'].*//;
 
 388         # is it a submit button before $locale->
 
 389         if (/$submitsearch/) {
 
 391           if ($` !~ /locale->text/) {
 
 393             $sub_line_no = $line_no;
 
 397         my ($found) = / (?: locale->text | \b t8 ) \b .*? \(/x;
 
 402           ($string, $_) = extract_text_between_parenthesis($fh, $postmatch);
 
 405           # if there is no $ in the string record it
 
 406           unless (($string =~ /\$\D.*/) || ("" eq $string)) {
 
 408             # this guarantees one instance of string
 
 409             $cached{$file}{locale}{$string} = 1;
 
 411             # this one is for all the locales
 
 412             $cached{$file}{all}{$string} = 1;
 
 414             # is it a submit button before $locale->
 
 416               $cached{$file}{submit}{$string} = 1;
 
 419         } elsif ($postmatch =~ />/) {
 
 423         # exit loop if there are no more locales on this line
 
 424         ($rc) = ($postmatch =~ /locale->text | \b t8/x);
 
 426         if (   ($postmatch =~ />/)
 
 427             || (!$found && ($sub_line_no != $line_no) && />/)) {
 
 437   $alllocales{$_} = 1             for keys %{$cached{$file}{all}};
 
 438   $locale{$_}     = 1             for keys %{$cached{$file}{locale}};
 
 439   $submit{$_}     = 1             for keys %{$cached{$file}{submit}};
 
 441   scanfile($_, 0, $scanned_files) for keys %{$cached{$file}{scan}};
 
 442   scanfile($_, 1, $scanned_files) for keys %{$cached{$file}{scannosubs}};
 
 443   scanhtmlfile($_)                for keys %{$cached{$file}{scanh}};
 
 445   $referenced_html_files{$_} = 1  for keys %{$cached{$file}{scanh}};
 
 451   my $fh = new FileHandle;
 
 452   open $fh, "$file" or die "$! : $file";
 
 454   my @a = grep m/^\[/, <$fh>;
 
 458   grep { s/(\[|\])//g } @a;
 
 460   foreach my $item (@a) {
 
 461     my @b = split /--/, $item;
 
 462     foreach my $string (@b) {
 
 464       $locale{$string}     = 1;
 
 465       $alllocales{$string} = 1;
 
 471 sub unescape_template_string {
 
 482   if (!defined $cached{$file}) {
 
 483     my %plugins = ( 'loaded' => { }, 'needed' => { } );
 
 485     open(IN, $file) || die $file;
 
 490     while (my $line = <IN>) {
 
 493       while ($line =~ m/\[\%[^\w]*use[^\w]+(\w+)[^\w]*?\%\]/gi) {
 
 494         $plugins{loaded}->{$1} = 1;
 
 497       while ($line =~ m/\[\%[^\w]*(\w+)\.\w+\(/g) {
 
 499         $plugins{needed}->{$plugin} = 1 if (first { $_ eq $plugin } qw(HTML LxERP JavaScript MultiColumnIterator L));
 
 502       while ($line =~ m/(?:             # Start von Variante 1: LxERP.t8('...'); ohne darumliegende [% ... %]-Tags
 
 503                           (LxERP\.t8)\( #   LxERP.t8(                             ::Parameter $1::
 
 504                           ([\'\"])      #   Anfang des zu übersetzenden Strings   ::Parameter $2::
 
 505                           (.*?)         #   Der zu übersetzende String            ::Parameter $3::
 
 506                           (?<!\\)\2     #   Ende des zu übersetzenden Strings
 
 507                         |               # Start von Variante 2: [% '...' | $T8 %]
 
 508                           \[\%          #   Template-Start-Tag
 
 509                           [\-~#]?       #   Whitespace-Unterdrückung
 
 510                           \s*           #   Optional beliebig viele Whitespace
 
 511                           ([\'\"])      #   Anfang des zu übersetzenden Strings   ::Parameter $4::
 
 512                           (.*?)         #   Der zu übersetzende String            ::Parameter $5::
 
 513                           (?<!\\)\4     #   Ende des zu übersetzenden Strings
 
 514                           \s*\|\s*      #   Pipe-Zeichen mit optionalen Whitespace davor und danach
 
 515                           (\$T8)        #   Filteraufruf                          ::Parameter $6::
 
 516                           .*?           #   Optionale Argumente für den Filter
 
 518                           [\-~#]?       #   Whitespace-Unterdrückung
 
 519                           \%\]          #   Template-Ende-Tag
 
 522         my $module = $1 || $6;
 
 523         my $string = $3 || $5;
 
 524         print "Found filter >>>$string<<<\n" if $debug;
 
 525         substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], '';
 
 527         $string                         = unescape_template_string($string);
 
 528         $cached{$file}{all}{$string}    = 1;
 
 529         $cached{$file}{html}{$string}   = 1;
 
 530         $cached{$file}{submit}{$string} = 1 if $PREMATCH =~ /$submitsearch/;
 
 531         $plugins{needed}->{T8}          = 1 if $module eq '$T8';
 
 532         $plugins{needed}->{LxERP}       = 1 if $module eq 'LxERP.t8';
 
 535       while ($line =~ m/\[\%          # Template-Start-Tag
 
 536                         [\-~#]?       # Whitespace-Unterdrückung
 
 537                         \s*           # Optional beliebig viele Whitespace
 
 538                         (?:           # Die erkannten Template-Direktiven
 
 543                         \s+           # Mindestens ein Whitespace
 
 544                         [\'\"]?       # Anfang des Dateinamens
 
 545                         ([^\s]+)      # Beliebig viele Nicht-Whitespaces -- Dateiname
 
 546                         \.html        # Endung ".html", ansonsten kann es der Name eines Blocks sein
 
 548         my $new_file_name = "$basedir/templates/webpages/$1.html";
 
 549         $cached{$file}{scanh}{$new_file_name} = 1;
 
 550         substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], '';
 
 556     foreach my $plugin (keys %{ $plugins{needed} }) {
 
 557       next if ($plugins{loaded}->{$plugin});
 
 558       print "E: " . strip_base($file) . " requires the Template plugin '$plugin', but is not loaded with '[\% USE $plugin \%]'.\n";
 
 562   # copy back into global arrays
 
 563   $alllocales{$_} = 1            for keys %{$cached{$file}{all}};
 
 564   $locale{$_}     = 1            for keys %{$cached{$file}{html}};
 
 565   $submit{$_}     = 1            for keys %{$cached{$file}{submit}};
 
 567   scanhtmlfile($_)               for keys %{$cached{$file}{scanh}};
 
 569   $referenced_html_files{$_} = 1 for keys %{$cached{$file}{scanh}};
 
 572 sub search_unused_htmlfiles {
 
 573   my @unscanned_dirs = ('../../templates/webpages');
 
 575   while (scalar @unscanned_dirs) {
 
 576     my $dir = shift @unscanned_dirs;
 
 578     foreach my $entry (<$dir/*>) {
 
 580         push @unscanned_dirs, $entry;
 
 582       } elsif (($entry =~ /_master.html$/) && -f $entry && !$referenced_html_files{$entry}) {
 
 583         print "W: unused HTML template: " . strip_base($entry) . "\n";
 
 591   my $s =  "$_[0]";             # Create a copy of the string.
 
 594   $s    =~ s|templates/webpages/||;
 
 601   $val =~ s/(\'|\\$)/\\$1/g;
 
 602   return  "'" . $val .  "'";
 
 606   my $key      = _single_quote(shift);
 
 607   my $text     = _single_quote(shift);
 
 609   my $template = $params{template} || qq|  %-29s => %s,\n|;
 
 610   my $fh       = $params{fh}       || croak 'need filehandle in _print_line';
 
 612   print $fh sprintf $template, $key, $text;
 
 618   my $file      = $params{file}   || croak 'need filename in generate_file';
 
 619   my $header    = $params{header};
 
 620   my $lines     = $params{data_sub};
 
 621   my $data_name = $params{data_name};
 
 622   my @delim     = split //, ($params{delim} || '{}');
 
 624   open my $fh, '>:encoding(utf8)', $file or die "$! : $file";
 
 626   $charset =~ s/\r?\n//g;
 
 627   my $emacs_charset = lc $charset;
 
 629   print $fh "#!/usr/bin/perl\n# -*- coding: $emacs_charset; -*-\n# vim: fenc=$charset\n\nuse utf8;\n\n";
 
 630   print $fh $header, "\n" if $header;
 
 631   print $fh "$data_name = $delim[0]\n" if $data_name;
 
 635   print $fh qq|$delim[1];\n\n1;\n|;
 
 641   do { local ( @ARGV, $/ ) = $file; <> }
 
 648 locales.pl - Collect strings for translation in kivitendo
 
 652 locales.pl [options] lang_code
 
 655   -n, --no-custom-files  Do not process files whose name contains "_"
 
 656   -c, --check-files      Run extended checks on HTML files
 
 657   -v, --verbose          Be more verbose
 
 658   -h, --help             Show this help
 
 664 =item B<-n>, B<--no-custom-files>
 
 666 Do not process files whose name contains "_", e.g. "custom_io.pl".
 
 668 =item B<-c>, B<--check-files>
 
 670 Run extended checks on the usage of templates. This can be used to
 
 671 discover HTML templates that are never used as well as the usage of
 
 672 non-existing HTML templates.
 
 674 =item B<-v>, B<--verbose>
 
 682 This script collects strings from Perl files, the menu.ini file and
 
 683 HTML templates and puts them into the file "all" for translation.