X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Flocales.pl;h=105ca7caefa8e605c38c84cc6551b466275fa687;hb=90a1b6fad6aeeab84fc96d6511fdf42fff315df5;hp=b6cccf11801538148bdcfe961c44717ee7e2abcb;hpb=49556f01cfe6a395cf5554e1a00dc61d6da0493e;p=kivitendo-erp.git diff --git a/scripts/locales.pl b/scripts/locales.pl index b6cccf118..105ca7cae 100755 --- a/scripts/locales.pl +++ b/scripts/locales.pl @@ -9,22 +9,36 @@ use utf8; use strict; +BEGIN { + use FindBin; + + unshift(@INC, $FindBin::Bin . '/../modules/override'); # Use our own versions of various modules (e.g. YAML). + push (@INC, $FindBin::Bin . '/..'); + push (@INC, $FindBin::Bin . '/../modules/fallback'); # Only use our own versions of modules if there's no system version. +} + use Carp; +use Cwd; use Data::Dumper; use English; 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; +use SL::System::Process; $OUTPUT_AUTOFLUSH = 1; my $opt_v = 0; my $opt_n = 0; my $opt_c = 0; +my $opt_f = 0; my $debug = 0; parse_args(); @@ -34,9 +48,7 @@ my $basedir = "../.."; my $locales_dir = "."; my $bindir = "$basedir/bin/mozilla"; my @progdirs = ( "$basedir/SL" ); -my $dbupdir = "$basedir/sql/Pg-upgrade"; -my $dbupdir2 = "$basedir/sql/Pg-upgrade2"; -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,6 +56,11 @@ our $self = {}; our $missing = {}; our @lost = (); +my %ignore_unused_templates = ( + map { $_ => 1 } qw(ct/testpage.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); my ($ALL_HEADER, $MISSING_HEADER, $LOST_HEADER); @@ -86,27 +103,31 @@ 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; -tie %dir_h, 'IO::Dir', $dbupdir; -my @dbplfiles = grep { /\.pl$/ } keys %dir_h; - -tie %dir_h, 'IO::Dir', $dbupdir2; -my @dbplfiles2 = grep { /\.pl$/ } keys %dir_h; +my @dbplfiles; +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; +} # slurp the translations in if (-f "$locales_dir/all") { require "$locales_dir/all"; } +# load custom translation (more_texts) +for my $file (glob("${locales_dir}/more/*")) { + if (open my $in, "<", "$file") { + local $/ = undef; + my $code = <$in>; + eval($code); + close($in); + $self->{more_texts_temp}{$_} = $self->{more_texts}{$_} for keys %{ $self->{more_texts} }; + } +} +$self->{more_texts} = delete $self->{more_texts_temp}; + if (-f "$locales_dir/missing") { require "$locales_dir/missing" ; unlink "$locales_dir/missing"; @@ -116,17 +137,14 @@ if (-f "$locales_dir/lost") { unlink "$locales_dir/lost"; } -my $charset = slurp("$locales_dir/charset") || 'utf-8'; -chomp $charset; - my %old_texts = %{ $self->{texts} || {} }; handle_file(@{ $_ }) for @progfiles; -handle_file($_, $dbupdir) for @dbplfiles; -handle_file($_, $dbupdir2) for @dbplfiles2; +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); } @@ -141,14 +159,15 @@ generate_file( data_sub => sub { _print_line($_, $self->{texts}{$_}, @_) for sort keys %alllocales }, ); -open(my $js_file, '>:encoding(utf8)', $javascript_output_dir .'/locale/'. $locale .'js') || die; -print $js_file '{'; +open(my $js_file, '>:encoding(utf8)', $javascript_output_dir .'/locale/'. $locale .'.js') || die; +print $js_file 'namespace("kivi").setupLocale({'; my $first_entry = 1; for my $key (sort(keys(%jslocale))) { print $js_file ((!$first_entry ? ',' : '') ."\n". _double_quote($key) .':'. _double_quote($self->{texts}{$key})); $first_entry = 0; } -print $js_file ("\n".'}'."\n"); +print $js_file ("\n"); +print $js_file ('});'."\n"); close($js_file); foreach my $text (keys %$missing) { @@ -161,9 +180,29 @@ close($js_file); # calc and generate missing -my @new_missing = grep { !$self->{texts}{$_} } sort keys %alllocales; +# don't add missing ones if we have a translation in more_texts +my @new_missing = grep { !$self->{more_texts}{$_} && !$self->{texts}{$_} } sort keys %alllocales; if (@new_missing) { + if ($opt_c) { + my %existing_lc = map { (lc $_ => $_) } grep { $self->{texts}->{$_} } keys %{ $self->{texts} }; + foreach my $entry (@new_missing) { + my $other = $existing_lc{lc $entry}; + print "W: No entry for '${entry}' exists, but there is one with different case: '${other}'\n" if $other; + } + } + + 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, @@ -226,15 +265,21 @@ EOL sub parse_args { my ($help, $man); + my ($opt_no_c, $ignore_for_compatiblity); + GetOptions( 'no-custom-files' => \$opt_n, - 'check-files' => \$opt_c, + 'check-files' => \$ignore_for_compatiblity, + 'no-check-files' => \$opt_no_c, 'verbose' => \$opt_v, + 'filenames' => \$opt_f, 'help' => \$help, 'man' => \$man, 'debug' => \$debug, ); + $opt_c = !$opt_no_c; + if ($help) { pod2usage(1); exit 0; @@ -267,6 +312,9 @@ sub parse_args { . "and no locale directory name was given.\n"; exit 1; } + + $locale ||= (grep { $_ } split m:/:, getcwd())[-1]; + $locale =~ s/\.+$//; } sub handle_file { @@ -357,7 +405,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); @@ -429,8 +477,11 @@ sub scanfile { } } - my ($found) = / (?: locale->text | \b t8 ) \b .*? \(/x; - $postmatch = "$'"; + my $found; + if (/ (?: locale->text | \b t8 ) \b .*? \(/x) { + $found = 1; + $postmatch = "$'"; + } if ($found) { my $string; @@ -483,24 +534,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}; + + $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; - # strip [] - grep { s/(\[|\])//g } @a; + my $dbu = SL::DBUpgrade2->new(auth => $auth, path => SL::System::Process->exe_dir . '/sql/Pg-upgrade2-auth'); - foreach my $item (@a) { - my @b = split /--/, $item; - foreach my $string (@b) { - chomp $string; + 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 { @@ -514,88 +572,91 @@ sub scanhtmlfile { my $file = shift; - if (!defined $cached{$file}) { - my %plugins = ( 'loaded' => { }, 'needed' => { } ); - - open(IN, $file) || die $file; + return if defined $cached{$file}; - my $copying = 0; - my $issubmit = 0; - my $text = ""; - while (my $line = ) { - chomp($line); + my %plugins = ( 'loaded' => { }, 'needed' => { } ); - while ($line =~ m/\[\%[^\w]*use[^\w]+(\w+)[^\w]*?\%\]/gi) { - $plugins{loaded}->{$1} = 1; - } + if (!open(IN, '<:encoding(utf8)', $file)) { + print "E: template file '$file' not found\n"; + return; + } - while ($line =~ m/\[\%[^\w]*(\w+)\.\w+\(/g) { - my $plugin = $1; - $plugins{needed}->{$plugin} = 1 if (first { $_ eq $plugin } qw(HTML LxERP JavaScript JSON L P)); - } + my $copying = 0; + my $issubmit = 0; + my $text = ""; + while (my $line = ) { + chomp($line); - $plugins{needed}->{T8} = 1 if $line =~ m/\[\%.*\|.*\$T8/; - - while ($line =~ m/(?: # Start von Variante 1: LxERP.t8('...'); ohne darumliegende [% ... %]-Tags - (LxERP\.t8)\( # LxERP.t8( ::Parameter $1:: - ([\'\"]) # Anfang des zu übersetzenden Strings ::Parameter $2:: - (.*?) # Der zu übersetzende String ::Parameter $3:: - (?>>$string<<<\n" if $debug; - substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], ''; - - $string = unescape_template_string($string); - $cached{$file}{all}{$string} = 1; - $cached{$file}{html}{$string} = 1; - $cached{$file}{submit}{$string} = 1 if $PREMATCH =~ /$submitsearch/; - $plugins{needed}->{T8} = 1 if $module eq '$T8'; - $plugins{needed}->{LxERP} = 1 if $module eq 'LxERP.t8'; - } + while ($line =~ m/\[\%[^\w]*use[^\w]+(\w+)[^\w]*?\%\]/gi) { + $plugins{loaded}->{$1} = 1; + } - while ($line =~ m/\[\% # Template-Start-Tag - [\-~#]? # Whitespace-Unterdrückung - \s* # Optional beliebig viele Whitespace - (?: # Die erkannten Template-Direktiven - PROCESS - | - INCLUDE - ) - \s+ # Mindestens ein Whitespace - [\'\"]? # Anfang des Dateinamens - ([^\s]+) # Beliebig viele Nicht-Whitespaces -- Dateiname - \.html # Endung ".html", ansonsten kann es der Name eines Blocks sein - /ix) { - my $new_file_name = "$basedir/templates/webpages/$1.html"; - $cached{$file}{scanh}{$new_file_name} = 1; - substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], ''; - } + while ($line =~ m/\[\%[^\w]*(\w+)\.\w+\(/g) { + my $plugin = $1; + $plugins{needed}->{$plugin} = 1 if (first { $_ eq $plugin } qw(HTML LxERP JavaScript JSON L P)); } - close(IN); + $plugins{needed}->{T8} = 1 if $line =~ m/\[\%.*\|.*\$T8/; + + while ($line =~ m/(?: # Start von Variante 1: LxERP.t8('...'); ohne darumliegende [% ... %]-Tags + (LxERP\.t8)\( # LxERP.t8( ::Parameter $1:: + ([\'\"]) # Anfang des zu übersetzenden Strings ::Parameter $2:: + (.*?) # Der zu übersetzende String ::Parameter $3:: + (?>>$string<<<\n" if $debug; + substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], ''; + + $string = unescape_template_string($string); + $cached{$file}{all}{$string} = 1; + $cached{$file}{html}{$string} = 1; + $cached{$file}{submit}{$string} = 1 if $PREMATCH =~ /$submitsearch/; + $plugins{needed}->{T8} = 1 if $module eq '$T8'; + $plugins{needed}->{LxERP} = 1 if $module eq 'LxERP.t8'; + } - foreach my $plugin (keys %{ $plugins{needed} }) { - next if ($plugins{loaded}->{$plugin}); - print "E: " . strip_base($file) . " requires the Template plugin '$plugin', but is not loaded with '[\% USE $plugin \%]'.\n"; + while ($line =~ m/\[\% # Template-Start-Tag + [\-~#]* # Whitespace-Unterdrückung + \s* # Optional beliebig viele Whitespace + (?: # Die erkannten Template-Direktiven + PROCESS + | + INCLUDE + ) + \s+ # Mindestens ein Whitespace + [\'\"]? # Anfang des Dateinamens + ([^\s]+) # Beliebig viele Nicht-Whitespaces -- Dateiname + \.(html|js) # Endung ".html" oder ".js", ansonsten kann es der Name eines Blocks sein + /ix) { + 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], ''; } } + close(IN); + + foreach my $plugin (keys %{ $plugins{needed} }) { + next if ($plugins{loaded}->{$plugin}); + print "E: " . strip_base($file) . " requires the Template plugin '$plugin', but is not loaded with '[\% USE $plugin \%]'.\n"; + } + # copy back into global arrays $alllocales{$_} = 1 for keys %{$cached{$file}{all}}; $locale{$_} = 1 for keys %{$cached{$file}{html}}; @@ -609,11 +670,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* @@ -641,7 +702,7 @@ sub search_unused_htmlfiles { if (-d $entry) { push @unscanned_dirs, $entry; - } elsif (($entry =~ /_master.html$/) && -f $entry && !$referenced_html_files{$entry}) { + } elsif (!$ignore_unused_templates{strip_base($entry)} && -f $entry && !$referenced_html_files{$entry}) { print "W: unused HTML template: " . strip_base($entry) . "\n"; } @@ -691,10 +752,7 @@ sub generate_file { open my $fh, '>:encoding(utf8)', $file or die "$! : $file"; - $charset =~ s/\r?\n//g; - my $emacs_charset = lc $charset; - - print $fh "#!/usr/bin/perl\n# -*- coding: $emacs_charset; -*-\n# vim: fenc=$charset\n\nuse utf8;\n\n"; + print $fh "#!/usr/bin/perl\n# -*- coding: utf-8; -*-\n# vim: fenc=utf-8\n\nuse utf8;\n\n"; print $fh $header, "\n" if $header; print $fh "$data_name = $delim[0]\n" if $data_name; @@ -704,11 +762,6 @@ sub generate_file { close $fh; } -sub slurp { - my $file = shift; - do { local ( @ARGV, $/ ) = $file; <> } -} - __END__ =head1 NAME @@ -722,6 +775,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 @@ -747,7 +801,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