misc/translator/text-extract2.pl

   1 #!/usr/bin/perl
   2
   3 # Test filter partially based on Ambrose's hideous subst.pl code
   4 # The idea is that the .tmpl files are not valid HTML, and as a result
   5 # HTML::Parse would be completely confused by these templates.
   6 # This is just a simple scanner (not a parser) & should give better results.
   7
   8 # This script is meant to be a drop-in replacement of text-extract.pl
   9
  10 # FIXME: Strings like "<< Prev" or "Next >>" may confuse *this* filter
  11 # TODO: Need to detect unclosed tags, empty tags, and other such stuff.
  12 # (Why? Because Mozilla apparently knows what SGML unclosed tags are :-/ )
  13
  14 # A grander plan: Code could be written to detect template variables and
  15 # construct gettext-c-format-string-like meta-strings (e.g., "Results %s
  16 # through %s of %s records" that will be more likely to be translatable
  17 # to languages where word order is very unlike English word order.
  18 # --> This will be relatively major rework, and requires corresponding
  19 # rework in tmpl_process.pl
  20
  21 use Getopt::Long;
  22 use strict;
  23
  24 use vars qw( $input );
  25 use vars qw( $debug_dump_only_p );
  26 use vars qw( $pedantic_p $pedantic_tag );
  27 use vars qw( $pedantic_attribute_error_in_nonpedantic_mode_p );
  28 use vars qw( $pedantic_tmpl_var_use_in_nonpedantic_mode_p );
  29 use vars qw( $fatal_p );
  30
  31 ###############################################################################
  32
  33 # Hideous stuff
  34 use vars qw( $re_directive $re_tmpl_var $re_tmpl_var_escaped $re_tmpl_include );
  35 use vars qw( $re_tmpl_endif_endloop );
  36 BEGIN {
  37     # $re_directive must not do any backreferences
  38     $re_directive = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:VAR|LOOP|INCLUDE|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  39     # TMPL_VAR or TMPL_INCLUDE
  40     $re_tmpl_var = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  41     $re_tmpl_include = q{<(?:(?i)(?:!--\s*)?TMPL_(?:INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  42     # TMPL_VAR ESCAPE=1/HTML/URL
  43     $re_tmpl_var_escaped = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR|INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))\s+ESCAPE=(?:1|HTML|URL)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  44     # /LOOP or /IF or /UNLESS
  45     $re_tmpl_endif_endloop = q{<(?:(?i)(?:!--\s*)?\/TMPL_(?:LOOP|IF|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  46 }
  47
  48 # Hideous stuff from subst.pl, slightly modified to use the above hideous stuff
  49 # Note: The $re_tag's set $1 (<tag), $2 (>), and $3 (rest of string)
  50 use vars qw( $re_comment $re_entity_name $re_end_entity $re_etag );
  51 use vars qw( $re_tag_strict $re_tag_compat @re_tag );
  52 sub re_tag ($) {
  53    my($compat) = @_;
  54    my $etag = $compat? '>': '<>\/';
  55    # See the file "subst.pl.test1" for how the following mess is derived
  56    # Unfortunately, inserting $re_directive's has made this even messier
  57    q{(<\/?(?:|(?:"(?:} . $re_directive . q{|[^"])*"|'(?:} . $re_directive . q{|[^'])*'|--(?:[^-]|-[^-])*--|(?:} . $re_directive . q{|[^-"'} . $etag . q{]|-[^-]))+))([} . $etag . q{])(.*)};
  58 }
  59 BEGIN {
  60     $re_comment = '(?:--(?:[^-]|-[^-])*--)';
  61     $re_entity_name = '(?:[^&%#;<>\s]+)'; # NOTE: not really correct SGML
  62     $re_end_entity = '(?:;|$|(?=\s))'; # semicolon or before-whitespace
  63     $re_etag = q{(?:<\/?(?:"[^"]*"|'[^']*'|[^"'>\/])*[>\/])}; # end-tag
  64     @re_tag = ($re_tag_strict, $re_tag_compat) = (re_tag(0), re_tag(1));
  65 }
  66
  67 # End of the hideous stuff
  68
  69 sub KIND_TEXT      () { 'TEXT' }
  70 sub KIND_CDATA     () { 'CDATA' }
  71 sub KIND_TAG       () { 'TAG' }
  72 sub KIND_DECL      () { 'DECL' }
  73 sub KIND_PI        () { 'PI' }
  74 sub KIND_DIRECTIVE () { 'HTML::Template' }
  75 sub KIND_COMMENT   () { 'COMMENT' }   # empty DECL with exactly one SGML comment
  76 sub KIND_UNKNOWN   () { 'ERROR' }
  77
  78 use vars qw( $readahead $lc_0 $lc $syntaxerror_p );
  79 use vars qw( $cdata_mode_p $cdata_close );
  80
  81 ###############################################################################
  82
  83 sub warn_pedantic ($$) {
  84     my($flag, $msg) = @_;
  85     warn "Warning$pedantic_tag: $msg\n" if $pedantic_p || !$$flag;
  86     if (!$pedantic_p) {
  87         warn "Warning$pedantic_tag: Further similar negligible warnings will not be reported, use --pedantic for details\n" unless $$flag;
  88         $$flag = 1;
  89     }
  90 }
  91
  92 ###############################################################################
  93
  94 sub extract_attributes ($;$) {
  95     my($s, $lc) = @_;
  96     my %attr;
  97     $s = $1 if $s =~ /^<\S+(.*)\/\S$/s  # XML-style self-closing tags
  98             || $s =~ /^<\S+(.*)\S$/s;   # SGML-style tags
  99
 100     for (my $i = 0; $s =~ /^\s+(?:([a-zA-Z][-a-zA-Z0-9]*)\s*=\s*)?('((?:$re_directive|[^'])*)'|"((?:$re_directive|[^"])*)"|(($re_directive|[^\s<>])+))/os;) {
 101         my($key, $val, $val_orig, $rest)
 102                 = ($1, (defined $3? $3: defined $4? $4: $5), $2, $');
 103         $i += 1;
 104         $attr{+lc($key)} = [$key, $val, $val_orig, $i];
 105         $s = $rest;
 106         if ($val =~ /$re_tmpl_include/os) {
 107             warn "Warning: TMPL_INCLUDE in attribute"
 108                 . (defined $lc? " near line $lc": '') . ": $val_orig\n";
 109         } elsif ($val =~ /$re_tmpl_var/os && $val !~ /$re_tmpl_var_escaped/os) {
 110             warn_pedantic \$pedantic_tmpl_var_use_in_nonpedantic_mode_p,
 111                     "Unescaped TMPL_VAR in attribute"
 112                     . (defined $lc? " near line $lc": '') . ": $val_orig"
 113                 if $pedantic_p || !$pedantic_tmpl_var_use_in_nonpedantic_mode_p;
 114         } elsif ($val_orig !~ /^['"]/) {
 115             warn_pedantic \$pedantic_attribute_error_in_nonpedantic_mode_p,
 116                 "Unquoted attribute contains character(s) that should be quoted"
 117                 . (defined $lc? " near line $lc": '') . ": $val_orig"
 118                 if $val =~ /[^-\.A-Za-z0-9]/s;
 119         }
 120     }
 121     my $s2 = $s; $s2 =~ s/$re_tmpl_endif_endloop//g; # for the next check
 122     if ($s2 =~ /\S/s) { # should never happen
 123         if ($s =~ /^([^\n]*)\n/s) { # this is even worse
 124             warn "Error: Completely confused while extracting attributes"
 125                     . (defined $lc? " near line $lc": '') . ": $1\n";
 126             warn "Error: " . (scalar split(/\n/, $s) - 1) . " more line(s) not shown.\n";
 127             $fatal_p = 1;
 128         } else {
 129             warn "Warning: Strange attribute syntax"
 130                     . (defined $lc? " near line $lc": '') . ": $s\n";
 131         }
 132     }
 133     return \%attr;
 134 }
 135
 136 sub next_token_internal (*) {
 137     my($h) = @_;
 138     my($it, $kind);
 139     my $eof_p = 0;
 140     if (!defined $readahead || !length $readahead) {
 141         my $next = scalar <$h>;
 142         $eof_p = !defined $next;
 143         if (!$eof_p) {
 144             $lc += 1;
 145             $readahead .= $next;
 146         }
 147     }
 148     $lc_0 = $lc;                        # remember line number of first line
 149     if ($eof_p && !length $readahead) { # nothing left to do
 150         ;
 151     } elsif ($readahead =~ /^\s+/s) {   # whitespace
 152         ($kind, $it, $readahead) = (KIND_TEXT, $&, $');
 153     # FIXME the following (the [<\s] part) is an unreliable HACK :-(
 154     } elsif ($readahead =~ /^(?:[^<]|<[<\s])+/s) {      # non-space normal text
 155         ($kind, $it, $readahead) = (KIND_TEXT, $&, $');
 156         warn "Warning: Unescaped < near line $lc_0: $it\n" if $it =~ /</s;
 157     } else {                            # tag/declaration/processing instruction
 158         my $ok_p = 0;
 159         for (;;) {
 160             if ($cdata_mode_p) {
 161                 if ($readahead =~ /^$cdata_close/) {
 162                     ($kind, $it, $readahead) = (KIND_TAG, $&, $');
 163                     $ok_p = 1;
 164                 } else {
 165                     ($kind, $it, $readahead) = (KIND_TEXT, $readahead, undef);
 166                     $ok_p = 1;
 167                 }
 168             } elsif ($readahead =~ /^$re_tag_compat/os) {
 169                 ($kind, $it, $readahead) = (KIND_TAG, "$1$2", $3);
 170                 $ok_p = 1;
 171             } elsif ($readahead =~ /^<!--(?:(?!-->).)*-->/s) {
 172                 ($kind, $it, $readahead) = (KIND_COMMENT, $&, $');
 173                 $ok_p = 1;
 174                 warn "Warning: Syntax error in comment at line $lc_0: $&\n";
 175                 $syntaxerror_p = 1;
 176             }
 177         last if $ok_p;
 178             my $next = scalar <$h>;
 179             $eof_p = !defined $next;
 180         last if $eof_p;
 181             $lc += 1;
 182             $readahead .= $next;
 183         }
 184         if ($kind ne KIND_TAG) {
 185             ;
 186         } elsif ($it =~ /^<!/) {
 187             $kind = KIND_DECL;
 188             $kind = KIND_COMMENT if $it =~ /^<!--(?:(?!-->).)*-->/;
 189         } elsif ($it =~ /^<\?/) {
 190             $kind = KIND_PI;
 191         }
 192         if ($it =~ /^$re_directive/ios && !$cdata_mode_p) {
 193             $kind = KIND_DIRECTIVE;
 194         }
 195         if (!$ok_p && $eof_p) {
 196             ($kind, $it, $readahead) = (KIND_UNKNOWN, $readahead, undef);
 197             $syntaxerror_p = 1;
 198         }
 199     }
 200     warn "Warning: Unrecognizable token found near line $lc_0: $it\n"
 201             if $kind eq KIND_UNKNOWN;
 202     return defined $it? (wantarray? ($kind, $it):
 203                                     [$kind, $it]): undef;
 204 }
 205
 206 sub next_token (*) {
 207     my($h) = @_;
 208     my $it;
 209     if (!$cdata_mode_p) {
 210         $it = next_token_internal($h);
 211         if (defined $it && $it->[0] eq KIND_TAG) { # FIXME
 212             ($cdata_mode_p, $cdata_close) = (1, "</$1\\s*>")
 213                     if $it->[1] =~ /^<(script|style|textarea)\b/i; #FIXME
 214             push @$it, extract_attributes($it->[1], $lc_0); #FIXME
 215         }
 216     } else {
 217         for ($it = '';;) {
 218             my $lc_prev = $lc;
 219             my $next = next_token_internal($h);
 220         last if !defined $next;
 221             if (defined $next && $next->[1] =~ /$cdata_close/i) { #FIXME
 222                 ($lc, $readahead) = ($lc_prev, $next->[1] . $readahead); #FIXME
 223                 $cdata_mode_p = 0;
 224             }
 225         last unless $cdata_mode_p;
 226             $it .= $next->[1]; #FIXME
 227         }
 228         $it = [KIND_CDATA, $it]; #FIXME
 229         $cdata_close = undef;
 230     }
 231     return defined $it? (wantarray? @$it: $it): undef;
 232 }
 233
 234 ###############################################################################
 235
 236 sub debug_dump (*) { # for testing only
 237     my($h) = @_;
 238     print "re_tag_compat is /$re_tag_compat/\n";
 239     for (;;) {
 240         my $s = next_token $h;
 241     last unless defined $s;
 242         printf "%s\n", ('-' x 79);
 243         my($kind, $t, $attr) = @$s; # FIXME
 244         printf "%s:\n", $kind;
 245         printf "%4dH%s\n", length($t),
 246                 join('', map {/[\0-\37]/? $_: "$_\b$_"} split(//, $t));
 247         if ($kind eq KIND_TAG && %$attr) {
 248             printf "Attributes:\n";
 249             for my $a (keys %$attr) {
 250                 my($key, $val, $val_orig, $order) = @{$attr->{$a}};
 251                 printf "%s = %dH%s -- %s\n", $a, length $val,
 252                 join('', map {/[\0-\37]/? $_: "$_\b$_"} split(//, $val)),
 253                 $val_orig;
 254             }
 255         }
 256     }
 257 }
 258
 259 ###############################################################################
 260
 261 sub trim ($) {
 262     my($s) = @_;
 263     $s =~ s/^(?:\s|\&nbsp$re_end_entity)+//os;
 264     $s =~ s/(?:\s|\&nbsp$re_end_entity)+$//os;
 265     return $s;
 266 }
 267
 268 ###############################################################################
 269
 270 sub text_extract (*) {
 271     my($h) = @_;
 272     my %text = ();
 273     for (;;) {
 274         my $s = next_token $h;
 275     last unless defined $s;
 276         my($kind, $t, $attr) = @$s; # FIXME
 277         if ($kind eq KIND_TEXT) {
 278             $t = trim $t;
 279             $text{$t} = 1 if $t =~ /\S/s;
 280         } elsif ($kind eq KIND_TAG && %$attr) {
 281             # value [tag=input], meta
 282             my $tag = lc($1) if $t =~ /^<(\S+)/s;
 283             for my $a ('alt', 'content', 'title', 'value') {
 284                 if ($attr->{$a}) {
 285                     next if $a eq 'content' && $tag ne 'meta';
 286                     next if $a eq 'value' && ($tag ne 'input'
 287                         || (ref $attr->{'type'} && $attr->{'type'}->[1] eq 'hidden')); # FIXME
 288                     my($key, $val, $val_orig, $order) = @{$attr->{$a}}; #FIXME
 289                     $val = trim $val;
 290                     $text{$val} = 1 if $val =~ /\S/s;
 291                 }
 292             }
 293         }
 294     }
 295     # Emit all extracted strings. Don't emit pure whitespace or pure numbers.
 296     for my $t (keys %text) {
 297         printf "%s\n", $t
 298             unless $t =~ /^(?:\s|\&nbsp$re_end_entity)*$/os || $t =~ /^\d+$/;
 299     }
 300 }
 301
 302 ###############################################################################
 303
 304 sub usage ($) {
 305     my($exitcode) = @_;
 306     my $h = $exitcode? *STDERR: *STDOUT;
 307     print $h <<EOF;
 308 Usage: $0 [OPTIONS]
 309 Extract strings from HTML file.
 310
 311       --debug-dump-only     Do not extract strings; but display scanned tokens
 312   -f, --file=FILE           Extract from the specified FILE
 313       --pedantic-warnings   Issue warnings even for detected problems which
 314                             are likely to be harmless
 315       --help                Display this help and exit
 316 EOF
 317     exit($exitcode);
 318 }
 319
 320 ###############################################################################
 321
 322 sub usage_error (;$) {
 323     print STDERR "$_[0]\n" if @_;
 324     print STDERR "Try `$0 --help' for more information.\n";
 325     exit(-1);
 326 }
 327
 328 ###############################################################################
 329
 330 GetOptions(
 331     'f|file=s'          => \$input,
 332     'debug-dump-only'   => \$debug_dump_only_p,
 333     'pedantic-warnings' => sub { $pedantic_p = 1 },
 334     'help'              => sub { usage(0) },
 335 ) || usage_error;
 336 $pedantic_tag = $pedantic_p? '': ' (negligible)';
 337 usage_error('Missing mandatory option -f') unless defined $input;
 338
 339 open(INPUT, "<$input") || die "$0: $input: $!\n";
 340 if ($debug_dump_only_p) {
 341     debug_dump(*INPUT);
 342 } else {
 343     text_extract(*INPUT);
 344 }
 345
 346 warn "Warning: This input will not work with Mozilla standards-compliant mode\n"
 347         if $syntaxerror_p;
 348
 349 close INPUT;
 350
 351 exit(-1) if $fatal_p;