X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Flocales.pl;h=1bf35df98ae95c9ed16fe954ee98127b8af733c5;hb=a6e0a7f493d24aec0eebede85eeaa5e724bd2e11;hp=00dc7fe316fb8b76d658cf75fa2f72d717259da3;hpb=50868b23fa58529558fd1cf3030e586f988c27ac;p=kivitendo-erp.git diff --git a/scripts/locales.pl b/scripts/locales.pl index 00dc7fe31..1bf35df98 100755 --- a/scripts/locales.pl +++ b/scripts/locales.pl @@ -1,47 +1,60 @@ #!/usr/bin/perl -# -n do not include custom_ scripts -# -v verbose mode, shows progress stuff - -# this version of locles processes not only all required .pl files +# this version of locales processes not only all required .pl files # but also all parse_html_templated files. 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 . '/..'); +} + 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 SL::DBUpgrade2; +use SL::System::Process; +use SL::YAML; $OUTPUT_AUTOFLUSH = 1; my $opt_v = 0; -my $opt_n = 0; my $opt_c = 0; +my $opt_f = 0; my $debug = 0; parse_args(); +my $locale; 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 @javascript_dirs = ($basedir .'/js', $basedir .'/templates/webpages'); +my @menufiles = glob("${basedir}/menus/*/*"); +my @javascript_dirs = ($basedir .'/js', $basedir .'/templates/webpages', $basedir .'/templates/mobile_webpages'); +my $javascript_output_dir = $basedir .'/js'; my $submitsearch = qr/type\s*=\s*[\"\']?submit/i; 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); @@ -83,28 +96,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); +my %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 @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; } -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; - # 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"; @@ -114,39 +130,44 @@ 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); } # merge entries to translate with entries from files 'missing' and 'lost' merge_texts(); -# generate all +# Generate "all" without translations in more_texts. +# But keep the ones which are in both old_texts (texts) and more_texts, +# because this are ones which are overwritten in more_texts for custom usage. +my %to_keep; +$to_keep{$_} = 1 for grep { !!$self->{more_texts}{$_} } keys %old_texts; +my @new_all = grep { $to_keep{$_} || !$self->{more_texts}{$_} } sort keys %alllocales; + generate_file( file => "$locales_dir/all", header => $ALL_HEADER, data_name => '$self->{texts}', - data_sub => sub { _print_line($_, $self->{texts}{$_}, @_) for sort keys %alllocales }, + data_sub => sub { _print_line($_, $self->{texts}{$_}, @_) for @new_all }, ); -open(my $js_file, '>:encoding(utf8)', $locales_dir .'/js.js') || die; -print $js_file '{'."\n"; +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 ? ',' : '') . _double_quote($key) .':'. _double_quote($self->{texts}{$key}) ."\n"; + my $trans = $self->{more_texts}{$key} // $self->{texts}{$key}; + print $js_file ((!$first_entry ? ',' : '') ."\n". _double_quote($key) .':'. _double_quote($trans)); $first_entry = 0; } -print $js_file '}'."\n"; +print $js_file ("\n"); +print $js_file ('});'."\n"); close($js_file); foreach my $text (keys %$missing) { @@ -159,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, @@ -224,15 +265,20 @@ 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; @@ -248,6 +294,9 @@ sub parse_args { my $ok = 0; foreach my $dir ("../locale/$arg", "locale/$arg", "../$arg", $arg) { next unless -d $dir && -f "$dir/all" && -f "$dir/LANGUAGE"; + + $locale = $arg; + $ok = chdir $dir; last; } @@ -262,6 +311,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 { @@ -352,7 +404,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); @@ -382,23 +434,25 @@ sub scanfile { # is this a template call? if (/(?:parse_html_template2?|render)\s*\(\s*[\"\']([\w\/]+)\s*[\"\']/) { - my $new_file_base = "$basedir/templates/webpages/$1."; + my $new_file_name = $1; if (/parse_html_template2/) { - print "E: " . strip_base($file) . " is still using 'parse_html_template2' for " . strip_base("${new_file_base}html") . ".\n"; + print "E: " . strip_base($file) . " is still using 'parse_html_template2' for $new_file_name.html.\n"; } my $found_one = 0; - foreach my $ext (qw(html js json)) { - my $new_file = "${new_file_base}${ext}"; - if (-f $new_file) { - $cached{$file}{scanh}{$new_file} = 1; - print "." if $opt_v; - $found_one = 1; + for my $space (qw(webpages mobile_webpages)) { + for my $ext (qw(html js json)) { + my $new_file = "$basedir/templates/$space/$new_file_name.$ext"; + if (-f $new_file) { + $cached{$file}{scanh}{$new_file} = 1; + print "." if $opt_v; + $found_one = 1; + } } } if ($opt_c && !$found_one) { - print "W: missing HTML template: " . strip_base($new_file_base) . "{html,json,js} (referenced from " . strip_base($file) . ")\n"; + print "W: missing HTML template: $new_file_name.{html,json,js} (referenced from " . strip_base($file) . ")\n"; } } @@ -424,8 +478,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; @@ -478,24 +535,31 @@ sub scanfile { sub scanmenu { my $file = shift; - my $fh = new FileHandle; - open $fh, "$file" or die "$! : $file"; + my $menu = SL::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; + + 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 { @@ -505,92 +569,96 @@ sub unescape_template_string { } sub scanhtmlfile { - local *IN; - - my $file = shift; + my ($file) = @_; - if (!defined $cached{$file}) { - my %plugins = ( 'loaded' => { }, 'needed' => { } ); + return if defined $cached{$file}; - open(IN, $file) || die $file; + my $template_space = $file =~ m{templates/(\w+)/} ? $1 : 'webpages'; - 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; - } + my $fh; + if (!open($fh, '<: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 MultiColumnIterator JSON L P)); - } + my $copying = 0; + my $issubmit = 0; + my $text = ""; + while (my $line = <$fh>) { + 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/$template_space/$1.$2"; + $cached{$file}{scanh}{$new_file_name} = 1; + substr $line, $LAST_MATCH_START[1], $LAST_MATCH_END[0] - $LAST_MATCH_START[0], ''; } } + close($fh); + + 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}}; @@ -604,11 +672,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* @@ -627,7 +695,7 @@ sub scan_javascript_file { close($fh); } sub search_unused_htmlfiles { - my @unscanned_dirs = ('../../templates/webpages'); + my @unscanned_dirs = ('../../templates/webpages', '../../templates/mobile_webpages'); while (scalar @unscanned_dirs) { my $dir = shift @unscanned_dirs; @@ -636,7 +704,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"; } @@ -648,7 +716,7 @@ sub strip_base { my $s = "$_[0]"; # Create a copy of the string. $s =~ s|^../../||; - $s =~ s|templates/webpages/||; + $s =~ s|templates/\w+/||; return $s; } @@ -686,10 +754,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; @@ -699,11 +764,6 @@ sub generate_file { close $fh; } -sub slurp { - my $file = shift; - do { local ( @ARGV, $/ ) = $file; <> } -} - __END__ =head1 NAME @@ -715,8 +775,9 @@ locales.pl - Collect strings for translation in kivitendo 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 + -c, --check-files Run extended checks on HTML files (default) + -n, --no-check-files Do not 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 @@ -724,15 +785,16 @@ locales.pl [options] lang_code =over 8 -=item B<-n>, B<--no-custom-files> - -Do not process files whose name contains "_", e.g. "custom_io.pl". - =item B<-c>, B<--check-files> Run extended checks on the usage of templates. This can be used to discover HTML templates that are never used as well as the usage of -non-existing HTML templates. +non-existing HTML templates. This is enabled by default. + +=item B<-n>, B<--no-check-files> + +Do not run extended checks on the usage of templates. See +C<--no-check-files>. =item B<-v>, B<--verbose> @@ -742,7 +804,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