X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Flocales.pl;h=1bf35df98ae95c9ed16fe954ee98127b8af733c5;hb=a27846ef2756ed0f59c29d256a5d43d6caaf0b58;hp=ccccea831345390ef8b332d03b11c6f9437caf3d;hpb=dbda14c263efd93aca3b7114015a47d86b8581e3;p=kivitendo-erp.git diff --git a/scripts/locales.pl b/scripts/locales.pl index ccccea831..1bf35df98 100755 --- a/scripts/locales.pl +++ b/scripts/locales.pl @@ -1,14 +1,18 @@ #!/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; @@ -17,15 +21,18 @@ 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(); @@ -35,8 +42,8 @@ my $basedir = "../.."; my $locales_dir = "."; my $bindir = "$basedir/bin/mozilla"; my @progdirs = ( "$basedir/SL" ); -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 = {}; @@ -44,7 +51,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 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); @@ -88,20 +96,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; @@ -111,6 +109,18 @@ foreach my $sub_dir ("Pg-upgrade", "Pg-upgrade2", "Pg-upgrade2-auth") { 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"; @@ -125,27 +135,35 @@ 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); } # 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)', $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})); + 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"); @@ -162,7 +180,8 @@ 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) { @@ -173,6 +192,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, @@ -238,10 +268,10 @@ sub parse_args { my ($opt_no_c, $ignore_for_compatiblity); GetOptions( - 'no-custom-files' => \$opt_n, '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 +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); @@ -404,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"; } } @@ -503,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}; + + $locale{$node->{name}} = 1; + $alllocales{$node->{name}} = 1; + $cached{$file}{all}{$node->{name}} = 1; + } +} - # strip [] - grep { s/(\[|\])//g } @a; +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 => SL::System::Process->exe_dir . '/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 { @@ -530,15 +569,16 @@ sub unescape_template_string { } sub scanhtmlfile { - local *IN; - - my $file = shift; + my ($file) = @_; return if defined $cached{$file}; + my $template_space = $file =~ m{templates/(\w+)/} ? $1 : 'webpages'; + my %plugins = ( 'loaded' => { }, 'needed' => { } ); - if (!open(IN, $file)) { + my $fh; + if (!open($fh, '<:encoding(utf8)', $file)) { print "E: template file '$file' not found\n"; return; } @@ -546,7 +586,7 @@ sub scanhtmlfile { my $copying = 0; my $issubmit = 0; my $text = ""; - while (my $line = ) { + while (my $line = <$fh>) { chomp($line); while ($line =~ m/\[\%[^\w]*use[^\w]+(\w+)[^\w]*?\%\]/gi) { @@ -594,7 +634,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,15 +644,15 @@ 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/$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(IN); + close($fh); foreach my $plugin (keys %{ $plugins{needed} }) { next if ($plugins{loaded}->{$plugin}); @@ -632,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* @@ -655,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; @@ -676,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; } @@ -724,11 +764,6 @@ sub generate_file { close $fh; } -sub slurp { - my $file = shift; - do { local ( @ARGV, $/ ) = $file; <> } -} - __END__ =head1 NAME @@ -740,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 @@ -749,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> @@ -767,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