mebil
[kivitendo-erp.git] / scripts / locales.pl
index ccccea8..2c31f87 100755 (executable)
@@ -9,6 +9,11 @@
 use utf8;
 use strict;
 
+BEGIN {
+  unshift(@INC, 'modules/override'); # Use our own versions of various modules (e.g. YAML).
+  push   (@INC, 'modules/fallback'); # Only use our own versions of modules if there's no system version.
+}
+
 use Carp;
 use Cwd;
 use Data::Dumper;
@@ -17,15 +22,19 @@ use File::Slurp qw(slurp);
 use FileHandle;
 use Getopt::Long;
 use IO::Dir;
+use List::MoreUtils qw(apply);
 use List::Util qw(first);
-use POSIX;
 use Pod::Usage;
+use YAML ();
+use YAML::Loader (); # YAML tries to load Y:L at runtime, but can't find it after we chdir'ed
+use SL::DBUpgrade2;
 
 $OUTPUT_AUTOFLUSH = 1;
 
 my $opt_v  = 0;
 my $opt_n  = 0;
 my $opt_c  = 0;
+my $opt_f  = 0;
 my $debug  = 0;
 
 parse_args();
@@ -35,7 +44,7 @@ my $basedir      = "../..";
 my $locales_dir  = ".";
 my $bindir       = "$basedir/bin/mozilla";
 my @progdirs     = ( "$basedir/SL" );
-my $menufile     = "menu.ini";
+my @menufiles    = glob("${basedir}/menus/*/*");
 my @javascript_dirs = ($basedir .'/js', $basedir .'/templates/webpages');
 my $javascript_output_dir = $basedir .'/js';
 my $submitsearch = qr/type\s*=\s*[\"\']?submit/i;
@@ -44,7 +53,8 @@ our $missing     = {};
 our @lost        = ();
 
 my %ignore_unused_templates = (
-  map { $_ => 1 } qw(common/help_overlay.html ct/testpage.html generic/autocomplete.html oe/periodic_invoices_email.txt part/testpage.html t/render.html t/render.js)
+  map { $_ => 1 } qw(ct/testpage.html generic/autocomplete.html oe/periodic_invoices_email.txt part/testpage.html t/render.html t/render.js task_server/failure_notification_email.txt
+                     failed_background_jobs_report/email.txt)
 );
 
 my (%referenced_html_files, %locale, %htmllocale, %alllocales, %cached, %submit, %jslocale);
@@ -89,19 +99,10 @@ my @customfiles  = grep /_custom/, @bindir_files;
 push @progfiles, map { m:^(.+)/([^/]+)$:; [ $2, $1 ] } grep { /\.pm$/ } map { find_files($_) } @progdirs;
 
 # put customized files into @customfiles
-my (@menufiles, %dir_h);
-
-if ($opt_n) {
-  @customfiles = ();
-  @menufiles   = ($menufile);
-} else {
-  tie %dir_h, 'IO::Dir', $basedir;
-  @menufiles = map { "$basedir/$_" } grep { /.*?_$menufile$/ } keys %dir_h;
-  unshift @menufiles, "$basedir/$menufile";
-}
+my %dir_h;
 
 my @dbplfiles;
-foreach my $sub_dir ("Pg-upgrade", "Pg-upgrade2", "Pg-upgrade2-auth") {
+foreach my $sub_dir ("Pg-upgrade2", "Pg-upgrade2-auth") {
   my $dir = "$basedir/sql/$sub_dir";
   tie %dir_h, 'IO::Dir', $dir;
   push @dbplfiles, map { [ $_, $dir ] } grep { /\.pl$/ } keys %dir_h;
@@ -125,8 +126,9 @@ my %old_texts = %{ $self->{texts} || {} };
 handle_file(@{ $_ })       for @progfiles;
 handle_file(@{ $_ })       for @dbplfiles;
 scanmenu($_)               for @menufiles;
+scandbupgrades();
 
-for my $file_name (map({find_files($_)} @javascript_dirs)) {
+for my $file_name (grep { /\.(?:js|html)$/i } map({find_files($_)} @javascript_dirs)) {
   scan_javascript_file($file_name);
 }
 
@@ -173,6 +175,17 @@ if (@new_missing) {
     }
   }
 
+  if ($opt_f) {
+    for my $string (@new_missing) {
+      print "new string '$string' in files:\n";
+      print join "",
+        map   { "  $_\n"                  }
+        apply { s{^(?:\.\./)+}{}          }
+        grep  { $cached{$_}{all}{$string} }
+        keys  %cached;
+    }
+  }
+
   generate_file(
     file      => "$locales_dir/missing",
     header    => $MISSING_HEADER,
@@ -242,6 +255,7 @@ sub parse_args {
     'check-files'     => \$ignore_for_compatiblity,
     'no-check-files'  => \$opt_no_c,
     'verbose'         => \$opt_v,
+    'filenames'       => \$opt_f,
     'help'            => \$help,
     'man'             => \$man,
     'debug'           => \$debug,
@@ -374,7 +388,7 @@ sub scanfile {
     return unless (-f "$file");
 
     my $fh = new FileHandle;
-    open $fh, "$file" or die "$! : $file";
+    open $fh, '<:encoding(utf8)', $file or die "$! : $file";
 
     my ($is_submit, $line_no, $sub_line_no) = (0, 0, 0);
 
@@ -503,24 +517,31 @@ sub scanfile {
 sub scanmenu {
   my $file = shift;
 
-  my $fh = new FileHandle;
-  open $fh, "$file" or die "$! : $file";
+  my $menu = YAML::LoadFile($file);
 
-  my @a = grep m/^\[/, <$fh>;
-  close($fh);
+  for my $node (@$menu) {
+    # possible for override files
+    next unless exists $node->{name};
 
-  # strip []
-  grep { s/(\[|\])//g } @a;
+    $locale{$node->{name}}     = 1;
+    $alllocales{$node->{name}} = 1;
+    $cached{$file}{all}{$node->{name}} = 1;
+  }
+}
+
+sub scandbupgrades {
+  # we only need to do this for auth atm, because only auth scripts can include new rights, which are translateable
+  my $auth = 1;
 
-  foreach my $item (@a) {
-    my @b = split /--/, $item;
-    foreach my $string (@b) {
-      chomp $string;
+  my $dbu = SL::DBUpgrade2->new(auth => $auth, path => '../../sql/Pg-upgrade2-auth');
+
+  for my $upgrade ($dbu->sort_dbupdate_controls) {
+    for my $string (@{ $upgrade->{locales} || [] }) {
       $locale{$string}     = 1;
       $alllocales{$string} = 1;
+    $cached{$upgrade->{tag}}{all}{$string} = 1;
     }
   }
-
 }
 
 sub unescape_template_string {
@@ -538,7 +559,7 @@ sub scanhtmlfile {
 
   my %plugins = ( 'loaded' => { }, 'needed' => { } );
 
-  if (!open(IN, $file)) {
+  if (!open(IN, '<:encoding(utf8)', $file)) {
     print "E: template file '$file' not found\n";
     return;
   }
@@ -594,7 +615,7 @@ sub scanhtmlfile {
     }
 
     while ($line =~ m/\[\%          # Template-Start-Tag
-                      [\-~#]?       # Whitespace-Unterdrückung
+                      [\-~#]*       # Whitespace-Unterdrückung
                       \s*           # Optional beliebig viele Whitespace
                       (?:           # Die erkannten Template-Direktiven
                         PROCESS
@@ -604,9 +625,9 @@ sub scanhtmlfile {
                       \s+           # Mindestens ein Whitespace
                       [\'\"]?       # Anfang des Dateinamens
                       ([^\s]+)      # Beliebig viele Nicht-Whitespaces -- Dateiname
-                      \.html        # Endung ".html", ansonsten kann es der Name eines Blocks sein
+                      \.(html|js)   # Endung ".html" oder ".js", ansonsten kann es der Name eines Blocks sein
                      /ix) {
-      my $new_file_name = "$basedir/templates/webpages/$1.html";
+      my $new_file_name = "$basedir/templates/webpages/$1.$2";
       $cached{$file}{scanh}{$new_file_name} = 1;
       substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], '';
     }
@@ -632,11 +653,11 @@ sub scanhtmlfile {
 sub scan_javascript_file {
   my ($file) = @_;
 
-  open(my $fh, $file) || die('can not open file: '. $file);
+  open(my $fh, '<:encoding(utf8)', $file) || die('can not open file: '. $file);
 
   while( my $line = readline($fh) ) {
     while( $line =~ m/
-                    kivi.t8
+                    \bk(?:ivi)?.t8
                     \s*
                     \(
                     \s*
@@ -724,11 +745,6 @@ sub generate_file {
   close $fh;
 }
 
-sub slurp {
-  my $file = shift;
-  do { local ( @ARGV, $/ ) = $file; <> }
-}
-
 __END__
 
 =head1 NAME
@@ -742,6 +758,7 @@ locales.pl [options] lang_code
  Options:
   -n, --no-custom-files  Do not process files whose name contains "_"
   -c, --check-files      Run extended checks on HTML files
+  -f, --filenames        Show the filenames where new strings where found
   -v, --verbose          Be more verbose
   -h, --help             Show this help
 
@@ -767,7 +784,7 @@ Be more verbose.
 
 =head1 DESCRIPTION
 
-This script collects strings from Perl files, the menu.ini file and
+This script collects strings from Perl files, the menu files and
 HTML templates and puts them into the file "all" for translation.
 
 =cut