misc/translator/TmplTokenizer.pm

   1 package TmplTokenizer;
   2
   3 use strict;
   4 use TmplTokenType;
   5 use TmplToken;
   6 use VerboseWarnings qw( pedantic_p error_normal warn_normal warn_pedantic );
   7 require Exporter;
   8
   9 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  10
  11 ###############################################################################
  12
  13 =head1 NAME
  14
  15 TmplTokenizer.pm - Simple-minded tokenizer class for HTML::Template .tmpl files
  16
  17 =head1 DESCRIPTION
  18
  19 Because .tmpl files contains HTML::Template directives
  20 that tend to confuse real parsers (e.g., HTML::Parse),
  21 it might be better to create a customized scanner
  22 to scan the template files for tokens.
  23 This module is a simple-minded attempt at such a scanner.
  24
  25 =cut
  26
  27 ###############################################################################
  28
  29 $VERSION = 0.02;
  30
  31 @ISA = qw(Exporter);
  32 @EXPORT_OK = qw();
  33
  34 use vars qw( $pedantic_attribute_error_in_nonpedantic_mode_p );
  35 use vars qw( $pedantic_tmpl_var_use_in_nonpedantic_mode_p );
  36 use vars qw( $pedantic_error_markup_in_pcdata_p );
  37
  38 ###############################################################################
  39
  40 # Hideous stuff
  41 use vars qw( $re_directive $re_tmpl_var $re_tmpl_var_escaped $re_tmpl_include );
  42 use vars qw( $re_directive_control $re_tmpl_endif_endloop );
  43 BEGIN {
  44     # $re_directive must not do any backreferences
  45     $re_directive = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:VAR|LOOP|INCLUDE|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  46     # TMPL_VAR or TMPL_INCLUDE
  47     $re_tmpl_var = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  48     $re_tmpl_include = q{<(?:(?i)(?:!--\s*)?TMPL_(?:INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  49     # TMPL_VAR ESCAPE=1/HTML/URL
  50     $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*(?:--)?)>};
  51     # Any control flow directive
  52     $re_directive_control = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:LOOP|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  53     # /LOOP or /IF or /UNLESS
  54     $re_tmpl_endif_endloop = q{<(?:(?i)(?:!--\s*)?\/TMPL_(?:LOOP|IF|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  55 }
  56
  57 # Hideous stuff from subst.pl, slightly modified to use the above hideous stuff
  58 # Note: The $re_tag's set $1 (<tag), $2 (>), and $3 (rest of string)
  59 use vars qw( $re_comment $re_entity_name $re_end_entity $re_etag );
  60 use vars qw( $re_tag_strict $re_tag_compat @re_tag );
  61 sub re_tag ($) {
  62    my($compat) = @_;
  63    my $etag = $compat? '>': '<>\/';
  64    # This is no longer similar to the original regexp in subst.pl :-(
  65    # Note that we don't want <> in compat mode; Mozilla knows about <
  66    q{(<\/?(?:|(?:"(?:} . $re_directive . q{|[^"])*"|'(?:} . $re_directive . q{|[^'])*'|--(?:(?!--)(?:$re_directive)*.)*--|(?:}
  67    . $re_directive
  68    . q{|(?!--)[^"'<>} . $etag . q{]))+))([} . $etag . q{]|(?=<))(.*)};
  69 }
  70 BEGIN {
  71     $re_comment = '(?:--(?:[^-]|-[^-])*--)';
  72     $re_entity_name = '(?:[^&%#;<>\s]+)'; # NOTE: not really correct SGML
  73     $re_end_entity = '(?:;|$|(?=\s))'; # semicolon or before-whitespace
  74     $re_etag = q{(?:<\/?(?:"[^"]*"|'[^']*'|[^"'>\/])*[>\/])}; # end-tag
  75     @re_tag = ($re_tag_strict, $re_tag_compat) = (re_tag(0), re_tag(1));
  76 }
  77
  78 # End of the hideous stuff
  79
  80 use vars qw( $serial );
  81
  82 ###############################################################################
  83
  84 sub FATAL_P             () {'fatal-p'}
  85 sub SYNTAXERROR_P       () {'syntaxerror-p'}
  86
  87 sub FILENAME            () {'input'}
  88 sub HANDLE              () {'handle'}
  89
  90 sub READAHEAD           () {'readahead'}
  91 sub LINENUM_START       () {'lc_0'}
  92 sub LINENUM             () {'lc'}
  93 sub CDATA_MODE_P        () {'cdata-mode-p'}
  94 sub CDATA_CLOSE         () {'cdata-close'}
  95 sub PCDATA_MODE_P       () {'pcdata-mode-p'}    # additional submode for CDATA
  96
  97 sub ALLOW_CFORMAT_P     () {'allow-cformat-p'}
  98
  99 sub new {
 100     my $this = shift;
 101     my($input) = @_;
 102     my $class = ref($this) || $this;
 103     my $self = {};
 104     bless $self, $class;
 105
 106     my $handle = sprintf('TMPLTOKENIZER%d', $serial);
 107     $serial += 1;
 108
 109     no strict;
 110     open($handle, "<$input") || die "$input: $!\n";
 111     use strict;
 112     $self->{+FILENAME} = $input;
 113     $self->{+HANDLE} = $handle;
 114     $self->{+READAHEAD} = [];
 115     return $self;
 116 }
 117
 118 ###############################################################################
 119
 120 # Simple getters
 121
 122 sub filename {
 123     my $this = shift;
 124     return $this->{+FILENAME};
 125 }
 126
 127 sub _handle {
 128     my $this = shift;
 129     return $this->{+HANDLE};
 130 }
 131
 132 sub fatal_p {
 133     my $this = shift;
 134     return $this->{+FATAL_P};
 135 }
 136
 137 sub syntaxerror_p {
 138     my $this = shift;
 139     return $this->{+SYNTAXERROR_P};
 140 }
 141
 142 sub has_readahead_p {
 143     my $this = shift;
 144     return @{$this->{+READAHEAD}};
 145 }
 146
 147 sub _peek_readahead {
 148     my $this = shift;
 149     return $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}];
 150 }
 151
 152 sub line_number_start {
 153     my $this = shift;
 154     return $this->{+LINENUM_START};
 155 }
 156
 157 sub line_number {
 158     my $this = shift;
 159     return $this->{+LINENUM};
 160 }
 161
 162 sub cdata_mode_p {
 163     my $this = shift;
 164     return $this->{+CDATA_MODE_P};
 165 }
 166
 167 sub pcdata_mode_p {
 168     my $this = shift;
 169     return $this->{+PCDATA_MODE_P};
 170 }
 171
 172 sub cdata_close {
 173     my $this = shift;
 174     return $this->{+CDATA_CLOSE};
 175 }
 176
 177 sub allow_cformat_p {
 178     my $this = shift;
 179     return $this->{+ALLOW_CFORMAT_P};
 180 }
 181
 182 # Simple setters
 183
 184 sub _set_fatal {
 185     my $this = shift;
 186     $this->{+FATAL_P} = $_[0];
 187     return $this;
 188 }
 189
 190 sub _set_syntaxerror {
 191     my $this = shift;
 192     $this->{+SYNTAXERROR_P} = $_[0];
 193     return $this;
 194 }
 195
 196 sub _push_readahead {
 197     my $this = shift;
 198     push @{$this->{+READAHEAD}}, $_[0];
 199     return $this;
 200 }
 201
 202 sub _pop_readahead {
 203     my $this = shift;
 204     return pop @{$this->{+READAHEAD}};
 205 }
 206
 207 sub _append_readahead {
 208     my $this = shift;
 209     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] .= $_[0];
 210     return $this;
 211 }
 212
 213 sub _set_readahead {
 214     my $this = shift;
 215     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] = $_[0];
 216     return $this;
 217 }
 218
 219 sub _increment_line_number {
 220     my $this = shift;
 221     $this->{+LINENUM} += 1;
 222     return $this;
 223 }
 224
 225 sub _set_line_number_start {
 226     my $this = shift;
 227     $this->{+LINENUM_START} = $_[0];
 228     return $this;
 229 }
 230
 231 sub _set_cdata_mode {
 232     my $this = shift;
 233     $this->{+CDATA_MODE_P} = $_[0];
 234     return $this;
 235 }
 236
 237 sub _set_pcdata_mode {
 238     my $this = shift;
 239     $this->{+PCDATA_MODE_P} = $_[0];
 240     return $this;
 241 }
 242
 243 sub _set_cdata_close {
 244     my $this = shift;
 245     $this->{+CDATA_CLOSE} = $_[0];
 246     return $this;
 247 }
 248
 249 sub set_allow_cformat {
 250     my $this = shift;
 251     $this->{+ALLOW_CFORMAT_P} = $_[0];
 252     return $this;
 253 }
 254
 255 ###############################################################################
 256
 257 sub _extract_attributes ($;$) {
 258     my $this = shift;
 259     my($s, $lc) = @_;
 260     my %attr;
 261     $s = $1 if $s =~ /^<(?:(?!$re_directive_control)\S)+(.*)\/\S$/s     # XML-style self-closing tags
 262             || $s =~ /^<(?:(?!$re_directive_control)\S)+(.*)\S$/s;      # SGML-style tags
 263
 264     for (my $i = 0; $s =~ /^(?:$re_directive_control)?\s+(?:$re_directive_control)?(?:([a-zA-Z][-a-zA-Z0-9]*)\s*=\s*)?('((?:$re_directive|[^'])*)'|"((?:$re_directive|[^"])*)"|((?:$re_directive|[^\s<>])+))/os;) {
 265         my($key, $val, $val_orig, $rest)
 266                 = ($1, (defined $3? $3: defined $4? $4: $5), $2, $');
 267         $i += 1;
 268         $attr{+lc($key)} = [$key, $val, $val_orig, $i];
 269         $s = $rest;
 270         if ($val =~ /$re_tmpl_include/os) {
 271             warn_normal "TMPL_INCLUDE in attribute: $val_orig\n", $lc;
 272         } elsif ($val =~ /$re_tmpl_var/os && $val !~ /$re_tmpl_var_escaped/os) {
 273             # XXX: we probably should not warn if key is "onclick" etc
 274             # XXX: there's just no reasonable thing to suggest
 275             my $suggest = ($key =~ /^(?:action|archive|background|cite|classid|codebase|data|datasrc|for|href|longdesc|profile|src|usemap)$/i? 'URL': 'HTML');
 276             undef $suggest if $key =~ /^(?:onblur|onchange|onclick|ondblclick|onfocus|onkeydown|onkeypress|onkeyup|onload|onmousedown|onmousemove|onmouseout|onmouseover|onmouseup|onreset|onselect|onsubmit|onunload)$/i;
 277             warn_pedantic
 278                     "Suggest ESCAPE=$suggest for TMPL_VAR in attribute \"$key\""
 279                         . ": $val_orig",
 280                     $lc, \$pedantic_tmpl_var_use_in_nonpedantic_mode_p
 281                 if defined $suggest && (pedantic_p || !$pedantic_tmpl_var_use_in_nonpedantic_mode_p);
 282         } elsif ($val_orig !~ /^['"]/) {
 283             my $t = $val; $t =~ s/$re_directive_control//os;
 284             warn_pedantic
 285                 "Unquoted attribute contains character(s) that should be quoted"
 286                     . ": $val_orig",
 287                 $lc, \$pedantic_attribute_error_in_nonpedantic_mode_p
 288                 if $t =~ /[^-\.A-Za-z0-9]/s;
 289         }
 290     }
 291     my $s2 = $s; $s2 =~ s/$re_tmpl_endif_endloop//g; # for the next check
 292     if ($s2 =~ /\S/s) { # should never happen
 293         if ($s =~ /^([^\n]*)\n/s) { # this is even worse
 294             error_normal("Completely confused while extracting attributes: $1", $lc);
 295             error_normal((scalar(split(/\n/, $s)) - 1) . " more line(s) not shown.", undef);
 296             $this->_set_fatal( 1 );
 297         } else {
 298             # There's something wrong with the attribute syntax.
 299             # We might be able to deduce a likely cause by looking more.
 300             if ($s =~ /^[a-z0-9]/is && "<foo $s>" =~ /^$re_tag_compat$/s) {
 301                 warn_normal "Probably missing whitespace before or missing quotation mark near: $s\n", $lc;
 302             } else {
 303                 warn_normal "Strange attribute syntax: $s\n", $lc;
 304             }
 305         }
 306     }
 307     return \%attr;
 308 }
 309
 310 sub _next_token_internal {
 311     my $this = shift;
 312     my($h) = @_;
 313     my($it, $kind);
 314     my $eof_p = 0;
 315     $this->_pop_readahead if $this->has_readahead_p
 316             && !ref $this->_peek_readahead
 317             && !length $this->_peek_readahead;
 318     if (!$this->has_readahead_p) {
 319         my $next = scalar <$h>;
 320         $eof_p = !defined $next;
 321         if (!$eof_p) {
 322             $this->_increment_line_number;
 323             $this->_push_readahead( $next );
 324         }
 325     }
 326     $this->_set_line_number_start( $this->line_number ); # remember 1st line num
 327     if ($this->has_readahead_p && ref $this->_peek_readahead) { # TmplToken obj.
 328         ($it, $kind) = ($this->_pop_readahead, undef);
 329     } elsif ($eof_p && !$this->has_readahead_p) {       # nothing left to do
 330         ;
 331     } elsif ($this->_peek_readahead =~ /^\s+/s) {       # whitespace
 332         ($kind, $it) = (TmplTokenType::TEXT, $&);
 333         $this->_set_readahead( $' );
 334     # FIXME the following (the [<\s] part) is an unreliable HACK :-(
 335     } elsif ($this->_peek_readahead =~ /^(?:[^<]|<[<\s])*(?:[^<\s])/s) {        # non-space normal text
 336         ($kind, $it) = (TmplTokenType::TEXT, $&);
 337         $this->_set_readahead( $' );
 338         warn_normal "Unescaped < in $it\n", $this->line_number_start
 339                 if !$this->cdata_mode_p && $it =~ /</s;
 340     } else {                            # tag/declaration/processing instruction
 341         my $ok_p = 0;
 342         my $bad_comment_p = 0;
 343         for (my $cdata_close = $this->cdata_close;;) {
 344             if ($this->cdata_mode_p) {
 345                 my $next = $this->_pop_readahead;
 346                 if ($next =~ /^$cdata_close/is) {
 347                     ($kind, $it) = (TmplTokenType::TAG, $&);
 348                     $this->_push_readahead( $' );
 349                     $ok_p = 1;
 350                 } elsif ($next =~ /^((?:(?!$cdata_close).)+)($cdata_close)/is) {
 351                     ($kind, $it) = (TmplTokenType::TEXT, $1);
 352                     $this->_push_readahead( "$2$'" );
 353                     $ok_p = 1;
 354                 } else {
 355                     ($kind, $it) = (TmplTokenType::TEXT, $next);
 356                     $ok_p = 1;
 357                 }
 358             } elsif ($this->_peek_readahead =~ /^$re_tag_compat/os) {
 359                 # If we detect a "closed start tag" but we know that the
 360                 # following token looks like a TMPL_VAR, don't stop
 361                 my($head, $tail, $post) = ($1, $2, $3);
 362                 if ($tail eq '' && $post =~ $re_tmpl_var) {
 363                     # Don't bother to show the warning if we're too confused
 364                     # FIXME. There's no method for _closed_start_tag_warning
 365                     if (!defined $this->{'_closed_start_tag_warning'}
 366                         || ($this->{'_closed_start_tag_warning'}->[0] eq $head
 367                         && $this->{'_closed_start_tag_warning'}->[1] != $this->line_number - 1)) {
 368                     warn_normal "Possible SGML \"closed start tag\" notation: $head<\n", $this->line_number
 369                             if split(/\n/, $head) < 10;
 370                     }
 371                     $this->{'_closed_start_tag_warning'} = [$head, $this->line_number];
 372                 } else {
 373                     ($kind, $it) = (TmplTokenType::TAG, "$head>");
 374                     $this->_set_readahead( $post );
 375                     $ok_p = 1;
 376                     warn_normal "SGML \"closed start tag\" notation: $head<\n", $this->line_number if $tail eq '';
 377                 }
 378             } elsif ($this->_peek_readahead =~ /^<!--(?:(?!-->)$re_directive*.)*-->/os) {
 379                 ($kind, $it) = (TmplTokenType::COMMENT, $&);
 380                 $this->_set_readahead( $' );
 381                 $ok_p = 1;
 382                 $bad_comment_p = 1;
 383             }
 384         last if $ok_p;
 385             my $next = scalar <$h>;
 386             $eof_p = !defined $next;
 387         last if $eof_p;
 388             $this->_increment_line_number;
 389             $this->_append_readahead( $next );
 390         }
 391         if ($kind ne TmplTokenType::TAG) {
 392             ;
 393         } elsif ($it =~ /^<!/) {
 394             $kind = TmplTokenType::DECL;
 395             $kind = TmplTokenType::COMMENT if $it =~ /^<!--(?:(?!-->).)*-->/;
 396             if ($kind == TmplTokenType::COMMENT && $it =~ /^<!--\s*#include/s) {
 397                 warn_normal "Apache #include directive found instead of HTML::Template <TMPL_INCLUDE> directive", $this->line_number_start;
 398             }
 399         } elsif ($it =~ /^<\?/) {
 400             $kind = TmplTokenType::PI;
 401         }
 402         if ($it =~ /^$re_directive/ios && !$this->cdata_mode_p) {
 403             $kind = TmplTokenType::DIRECTIVE;
 404         } elsif ($bad_comment_p) {
 405             warn_normal sprintf("Syntax error in comment: %s\n", $it),
 406                     $this->line_number_start;
 407             $this->_set_syntaxerror( 1 );
 408         }
 409         if (!$ok_p && $eof_p) {
 410             ($kind, $it) = (TmplTokenType::UNKNOWN, $this->_peek_readahead);
 411             $this->_set_readahead, undef;
 412             $this->_set_syntaxerror( 1 );
 413         }
 414     }
 415     warn_normal "Unrecognizable token found: "
 416             . (split(/\n/, $it) < 10? $it: '(too confused to show details)')
 417             . "\n", $this->line_number_start
 418         if $kind == TmplTokenType::UNKNOWN;
 419     return defined $it? (ref $it? $it: TmplToken->new($it, $kind, $this->line_number, $this->filename)): undef;
 420 }
 421
 422 sub _next_token_intermediate {
 423     my $this = shift;
 424     my $h = $this->_handle;
 425     my $it;
 426     if (!$this->cdata_mode_p) {
 427         $it = $this->_next_token_internal($h);
 428         if (defined $it && $it->type == TmplTokenType::TAG) {
 429             if ($it->string =~ /^<(script|style|textarea)\b/is) {
 430                 $this->_set_cdata_mode( 1 );
 431                 $this->_set_cdata_close( "</$1\\s*>" );
 432                 $this->_set_pcdata_mode( 0 );
 433 #           } elsif ($it->string =~ /^<(title)\b/is) {
 434 #               $this->_set_cdata_mode( 1 );
 435 #               $this->_set_cdata_close( "</$1\\s*>" );
 436 #               $this->_set_pcdata_mode( 1 );
 437             }
 438             $it->set_attributes( $this->_extract_attributes($it->string, $it->line_number) );
 439         }
 440     } else {
 441         my $eof_p = 0;
 442         for ($it = '', my $cdata_close = $this->cdata_close;;) {
 443             my $next = $this->_next_token_internal($h);
 444             $eof_p = !defined $next;
 445         last if $eof_p;
 446             if (defined $next && $next->string =~ /$cdata_close/is) {
 447                 $this->_push_readahead( $next ); # push entire TmplToken object
 448                 $this->_set_cdata_mode( 0 );
 449             }
 450         last unless $this->cdata_mode_p;
 451             $it .= $next->string;
 452         }
 453         if ($eof_p) {
 454             $it = undef;
 455             error_normal "Unexpected end of file while looking for "
 456                     . $this->cdata_close
 457                     . "\n", $this->line_number_start;
 458             $this->_set_fatal( 1 );
 459             $this->_set_syntaxerror( 1 );
 460         }
 461         if ($this->pcdata_mode_p) {
 462             my $check = $it;
 463             $check =~ s/$re_directive//gos;
 464             warn_pedantic "Markup found in PCDATA\n", $this->line_number,
 465                             \$pedantic_error_markup_in_pcdata_p
 466                     if $check =~ /$re_tag_compat/s;
 467         }
 468         # PCDATA should be treated as text, not CDATA
 469         # Actually it should be treated as TEXT_PARAMETRIZED :-(
 470         $it = TmplToken->new( $it,
 471                         ($this->pcdata_mode_p?
 472                             TmplTokenType::TEXT: TmplTokenType::CDATA),
 473                         $this->line_number )
 474                 if defined $it;
 475         $this->_set_pcdata_mode, 0;
 476         $this->_set_cdata_close, undef unless !defined $it;
 477     }
 478     return $it;
 479 }
 480
 481 sub _token_groupable1_p ($) { # as first token, groupable into TEXT_PARAMETRIZED
 482     my($t) = @_;
 483     return ($t->type == TmplTokenType::TEXT && $t->string !~ /^[,\.:\|\s]+$/is)
 484         || ($t->type == TmplTokenType::DIRECTIVE
 485                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
 486         || ($t->type == TmplTokenType::TAG
 487                 && ($t->string =~ /^<(?:a|b|em|h[123456]|i|u)\b/is
 488                 || ($t->string =~ /^<input\b/is
 489                     && $t->attributes->{'type'}->[1] =~ /^(?:radio|text)$/is)
 490                     ))
 491 }
 492
 493 sub _token_groupable2_p ($) { # as other token, groupable into TEXT_PARAMETRIZED
 494     my($t) = @_;
 495     return ($t->type == TmplTokenType::TEXT && ($t->string =~ /^\s*$/s || $t->string !~ /^[\|\s]+$/is))
 496         || ($t->type == TmplTokenType::DIRECTIVE
 497                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
 498         || ($t->type == TmplTokenType::TAG
 499                 && ($t->string =~ /^<\/?(?:a|b|em|h[123456]|i|u)\b/is
 500                 || ($t->string =~ /^<input\b/is
 501                     && $t->attributes->{'type'}->[1] =~ /^(?:radio|text)$/is)))
 502 }
 503
 504 sub _quote_cformat ($) {
 505     my($s) = @_;
 506     $s =~ s/%/%%/g;
 507     return $s;
 508 }
 509
 510 sub string_canon ($) {
 511     my($s) = @_;
 512     if (1) { # FIXME
 513         # Fold all whitespace into single blanks
 514         $s =~ s/\s+/ /gs;
 515     }
 516     return $s;
 517 }
 518
 519 sub _formalize_string_cformat ($) {
 520     my($s) = @_;
 521     return _quote_cformat string_canon $s;
 522 }
 523
 524 sub _formalize ($) {
 525     my($t) = @_;
 526     return $t->type == TmplTokenType::DIRECTIVE? '%s':
 527            $t->type == TmplTokenType::TEXT?
 528                    _formalize_string_cformat($t->string):
 529            $t->type == TmplTokenType::TAG?
 530                    ($t->string =~ /^<a\b/is? '<a>':
 531                     $t->string =~ /^<input\b/is? (
 532                             lc $t->attributes->{'type'}->[1] eq 'text' ? '%S':
 533                             '%p'):
 534                     _quote_cformat($t->string)):
 535                _quote_cformat($t->string);
 536 }
 537
 538 sub _optimize {
 539     my $this = shift;
 540     my @structure = @_;
 541     my $undo_trailing_blanks = sub {
 542                 for (my $i = $#structure; $i >= 0; $i -= 1) {
 543                 last if $structure[$i]->type != TmplTokenType::TEXT;
 544                 last if !blank_p($structure[$i]->string);
 545                     # Queue element structure: [reanalysis-p, token]
 546                     push @{$this->{_queue}}, [1, pop @structure];
 547                 }
 548             };
 549     &$undo_trailing_blanks;
 550     while (@structure >= 2) {
 551         my $something_done_p = 0;
 552         # FIXME: If the last token is a close tag but there are no tags
 553         # FIXME: before it, drop the close tag back into the queue. This
 554         # FIXME: is an ugly hack to get rid of "foo %s</h1>" type mess.
 555         if (@structure >= 2
 556                 && $structure[$#structure]->type == TmplTokenType::TAG
 557                 && $structure[$#structure]->string =~ /^<\//s) {
 558             my $has_other_tags_p = 0;
 559             for (my $i = 0; $i < $#structure; $i += 1) {
 560                 $has_other_tags_p = 1
 561                         if $structure[$i]->type == TmplTokenType::TAG;
 562             last if $has_other_tags_p;
 563             }
 564             if (!$has_other_tags_p) {
 565                 push @{$this->{_queue}}, [0, pop @structure]
 566                 &$undo_trailing_blanks;
 567                 $something_done_p = 1;
 568             }
 569         }
 570         # FIXME: Do the same ugly hack for the last token being a ( or [
 571         if (@structure >= 2
 572                 && $structure[$#structure]->type == TmplTokenType::TEXT
 573                 && $structure[$#structure]->string =~ /^[\(\[]$/) { # not )]
 574             push @{$this->{_queue}}, [1, pop @structure];
 575             &$undo_trailing_blanks;
 576             $something_done_p = 1;
 577         }
 578         # FIXME: If the first token is an open tag, the last token is the
 579         # FIXME: corresponding close tag, and there are no other close tags
 580         # FIXME: inbetween, requeue the tokens from the second token on,
 581         # FIXME: flagged as ok for re-analysis
 582         if (@structure >= 3
 583                 && $structure[0]->type == TmplTokenType::TAG
 584                 && $structure[0]->string =~ /^<([a-z0-9])/is && (my $tag = $1)
 585                 && $structure[$#structure]->type == TmplTokenType::TAG
 586                 && $structure[$#structure]->string =~ /^<\/$1\s*>$/is) {
 587             my $has_other_open_or_close_tags_p = 0;
 588             for (my $i = 1; $i < $#structure; $i += 1) {
 589                 $has_other_open_or_close_tags_p = 1
 590                         if $structure[$i]->type == TmplTokenType::TAG
 591                         && $structure[$i]->string =~ /^<\/?$tag\b/is;
 592             last if $has_other_open_or_close_tags_p;
 593             }
 594             if (!$has_other_open_or_close_tags_p) {
 595                 for (my $i = $#structure; $i; $i -= 1) {
 596                     push @{$this->{_queue}}, [1, pop @structure];
 597                 }
 598                 $something_done_p = 1;
 599             }
 600         }
 601     last if !$something_done_p;
 602     }
 603     return @structure;
 604 }
 605
 606 sub looks_plausibly_like_groupable_text_p (@) {
 607     my @structure = @_;
 608     # The text would look plausibly groupable if all open tags are also closed.
 609     my @tags = ();
 610     my $error_p = 0;
 611     for (my $i = 0; $i <= $#structure; $i += 1) {
 612         if ($structure[$i]->type == TmplTokenType::TAG) {
 613             if ($structure[$i]->string =~ /^<([A-Z0-9]+)/is) {
 614                 my $tag = lc($1);
 615                 push @tags, $tag unless $tag =~ /^<(?:input)/is
 616                         || $tag =~ /\/>$/is;
 617             } elsif ($structure[$i]->string =~ /^<\/([A-Z0-9]+)/is) {
 618                 if (@tags && lc($1) eq $tags[$#tags]) {
 619                     pop @tags;
 620                 } else {
 621                     $error_p = 1;
 622                 }
 623             }
 624         } elsif ($structure[$i]->type != TmplTokenType::TEXT) {
 625             $error_p = 1;
 626         }
 627     last if $error_p;
 628     }
 629     return !$error_p && !@tags;
 630 }
 631
 632 sub next_token {
 633     my $this = shift;
 634     my $h = $this->_handle;
 635     my $it;
 636     $this->{_queue} = [] unless defined $this->{_queue};
 637
 638     # Elements in the queue are ordered pairs. The first in the ordered pair
 639     # specifies whether we are allowed to reanalysis; the second is the token.
 640     if (@{$this->{_queue}} && !$this->{_queue}->[$#{$this->{_queue}}]->[0]) {
 641         $it = (pop @{$this->{_queue}})->[1];
 642     } else {
 643         if (@{$this->{_queue}}) {
 644             $it = (pop @{$this->{_queue}})->[1];
 645         } else {
 646             $it = $this->_next_token_intermediate($h);
 647         }
 648         if (!$this->cdata_mode_p && $this->allow_cformat_p && defined $it
 649             && ($it->type == TmplTokenType::TEXT?
 650                 !blank_p( $it->string ): _token_groupable1_p( $it ))) {
 651             my @structure = ( $it );
 652             my @tags = ();
 653             my $next = undef;
 654             my($nonblank_text_p, $parametrized_p, $with_anchor_p, $with_input_p) = (0, 0, 0, 0);
 655             if ($it->type == TmplTokenType::TEXT) {
 656                 $nonblank_text_p = 1 if !blank_p( $it->string );
 657             } elsif ($it->type == TmplTokenType::DIRECTIVE) {
 658                 $parametrized_p = 1;
 659             } elsif ($it->type == TmplTokenType::TAG && $it->string =~ /^<([A-Z0-9]+)/is) {
 660                 push @tags, lc($1);
 661                 $with_anchor_p = 1 if lc($1) eq 'a';
 662                 $with_input_p = 1 if lc($1) eq 'input';
 663             }
 664             # We hate | and || in msgid strings, so we try to avoid them
 665             for (my $i = 1, my $quit_p = 0, my $quit_next_p = ($it->type == TmplTokenType::TEXT && $it->string =~ /^\|+$/s);; $i += 1) {
 666                 if (@{$this->{_queue}}) {
 667                     $next = (pop @{$this->{_queue}})->[1];
 668                 } else {
 669                     $next = $this->_next_token_intermediate($h);
 670                 }
 671                 push @structure, $next; # for consistency (with initialization)
 672             last unless defined $next && _token_groupable2_p( $next );
 673             last if $quit_next_p;
 674                 if ($next->type == TmplTokenType::TEXT) {
 675                     $nonblank_text_p = 1 if !blank_p( $next->string );
 676                     $quit_p = 1 if $next->string =~ /^\|+$/s; # We hate | and ||
 677                 } elsif ($next->type == TmplTokenType::DIRECTIVE) {
 678                     $parametrized_p = 1;
 679                 } elsif ($next->type == TmplTokenType::TAG) {
 680                     if ($next->string =~ /^<([A-Z0-9]+)/is) {
 681                         my $candidate = lc($1);
 682                         push @tags, $candidate
 683                                 unless $candidate =~ /^(?:input)$/is;
 684                         $with_anchor_p = 1 if lc($1) eq 'a';
 685                         $with_input_p = 1 if lc($1) eq 'input';
 686                     } elsif ($next->string =~ /^<\/([A-Z0-9]+)/is) {
 687                         my $close = lc($1);
 688                         $quit_p = 1 unless @tags && $close eq $tags[$#tags];
 689                         $quit_next_p = 1 if $close =~ /^h\d$/;
 690                         pop @tags;
 691                     }
 692                 }
 693             last if $quit_p;
 694             }
 695             # Undo the last token, allowing reanalysis
 696             push @{$this->{_queue}}, [1, pop @structure];
 697             # Simply it a bit more
 698             @structure = $this->_optimize( @structure );
 699             if (@structure < 2) {
 700                 # Nothing to do
 701                 ;
 702             } elsif ($nonblank_text_p && ($parametrized_p || $with_anchor_p || $with_input_p)) {
 703                 # Create the corresponding c-format string
 704                 my $string = join('', map { $_->string } @structure);
 705                 my $form = join('', map { _formalize $_ } @structure);
 706                 my($a_counter, $input_counter) = (0, 0);
 707                 $form =~ s/<a>/ $a_counter += 1, "<a$a_counter>" /egs;
 708                 $form =~ s/<input>/ $input_counter += 1, "<input$input_counter>" /egs;
 709                 $it = TmplToken->new($string, TmplTokenType::TEXT_PARAMETRIZED,
 710                         $it->line_number, $it->pathname);
 711                 $it->set_form( $form );
 712                 $it->set_children( @structure );
 713             } elsif ($nonblank_text_p
 714                     && looks_plausibly_like_groupable_text_p( @structure )
 715                     && $structure[$#structure]->type == TmplTokenType::TEXT) {
 716                 # Combine the strings
 717                 my $string = join('', map { $_->string } @structure);
 718                 $it = TmplToken->new($string, TmplTokenType::TEXT,
 719                         $it->line_number, $it->pathname);;
 720             } else {
 721                 # Requeue the tokens thus seen for re-emitting, allow reanalysis
 722                 for (;;) {
 723                     push @{$this->{_queue}}, [1, pop @structure];
 724                 last if !@structure;
 725                 }
 726                 $it = (pop @{$this->{_queue}})->[1];
 727             }
 728         }
 729     }
 730     if (defined $it && $it->type == TmplTokenType::TEXT) {
 731         my $form = string_canon $it->string;
 732         $it->set_form( $form );
 733     }
 734     return $it;
 735 }
 736
 737 ###############################################################################
 738
 739 # Other simple functions (These are not methods)
 740
 741 sub blank_p ($) {
 742     my($s) = @_;
 743     return $s =~ /^(?:\s|\&nbsp$re_end_entity|$re_tmpl_var)*$/os;
 744 }
 745
 746 sub trim ($) {
 747     my($s0) = @_;
 748     my $l0 = length $s0;
 749     my $s = $s0;
 750     $s =~ s/^(\s|\&nbsp$re_end_entity)+//os; my $l1 = $l0 - length $s;
 751     $s =~ s/(\s|\&nbsp$re_end_entity)+$//os; my $l2 = $l0 - $l1 - length $s;
 752     return wantarray? (substr($s0, 0, $l1), $s, substr($s0, $l0 - $l2)): $s;
 753 }
 754
 755 sub quote_po ($) {
 756     my($s) = @_;
 757     # Locale::PO->quote is buggy, it doesn't quote newlines :-/
 758     $s =~ s/([\\"])/\\\1/gs;
 759     $s =~ s/\n/\\n/g;
 760     #$s =~ s/[\177-\377]/ sprintf("\\%03o", ord($&)) /egs;
 761     return "\"$s\"";
 762 }
 763
 764 # Some functions that shouldn't be here... should be moved out some time
 765 sub parametrize ($$$$) {
 766     my($fmt_0, $cformat_p, $t, $f) = @_;
 767     my $it = '';
 768     if ($cformat_p) {
 769         my @params = $t->parameters_and_fields;
 770         for (my $n = 0, my $fmt = $fmt_0; length $fmt;) {
 771             if ($fmt =~ /^[^%]+/) {
 772                 $fmt = $';
 773                 $it .= $&;
 774             } elsif ($fmt =~ /^%%/) {
 775                 $fmt = $';
 776                 $it .= '%';
 777             } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?s/s) {
 778                 $n += 1;
 779                 my($i, $width, $prec) = ((defined $1? $1: $n), $2, $3);
 780                 $fmt = $';
 781                 if (defined $width && defined $prec && !$width && !$prec) {
 782                     ;
 783                 } elsif (defined $params[$i - 1]) {
 784                     my $param = $params[$i - 1];
 785                     warn_normal "$fmt_0: $&: Expected a TMPL_VAR, but found a "
 786                             . $param->type->to_string . "\n", undef
 787                             if $param->type != TmplTokenType::DIRECTIVE;
 788                     warn_normal "$fmt_0: $&: Unsupported "
 789                                 . "field width or precision\n", undef
 790                             if defined $width || defined $prec;
 791                     warn_normal "$fmt_0: $&: Parameter $i not known", undef
 792                             unless defined $param;
 793                     $it .= defined $f? &$f( $param ): $param->string;
 794                 }
 795             } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?([pS])/s) {
 796                 $n += 1;
 797                 my($i, $width, $prec, $conv) = ((defined $1? $1: $n), $2, $3, $4);
 798                 $fmt = $';
 799
 800                 my $param = $params[$i - 1];
 801                 if (!defined $param) {
 802                     warn_normal "$fmt_0: $&: Parameter $i not known", undef;
 803                 } else {
 804                     if ($param->type == TmplTokenType::TAG
 805                             && $param->string =~ /^<input\b/is) {
 806                         my $type = defined $param->attributes?
 807                                 lc($param->attributes->{'type'}->[1]): undef;
 808                         if ($conv eq 'S') {
 809                             warn_normal "$fmt_0: $&: Expected type=text, "
 810                                         . "but found type=$type", undef
 811                                     unless $type eq 'text';
 812                         } elsif ($conv eq 'p') {
 813                             warn_normal "$fmt_0: $&: Expected type=radio, "
 814                                         . "but found type=$type", undef
 815                                     unless $type eq 'radio';
 816                         }
 817                     } else {
 818                         warn_normal "$&: Expected an INPUT, but found a "
 819                                 . $param->type->to_string . "\n", undef
 820                     }
 821                     warn_normal "$fmt_0: $&: Unsupported "
 822                                 . "field width or precision\n", undef
 823                             if defined $width || defined $prec;
 824                     $it .= defined $f? &$f( $param ): $param->string;
 825                 }
 826             } elsif ($fmt =~ /^%[^%a-zA-Z]*[a-zA-Z]/) {
 827                 $fmt = $';
 828                 $it .= $&;
 829                 die "$&: Unknown or unsupported format specification\n"; #XXX
 830             } else {
 831                 die "$&: Completely confused parametrizing\n";#XXX
 832             }
 833         }
 834     }
 835     my @anchors = $t->anchors;
 836     for (my $n = 0, my $fmt = $it, $it = ''; length $fmt;) {
 837         if ($fmt =~ /^(?:(?!<a\d+>).)+/is) {
 838             $fmt = $';
 839             $it .= $&;
 840         } elsif ($fmt =~ /^<a(\d+)>/is) {
 841             $n += 1;
 842             my $i  = $1;
 843             $fmt = $';
 844             my $anchor = $anchors[$i - 1];
 845             warn_normal "$&: Anchor $1 not found for msgid \"$fmt_0\"", undef #FIXME
 846                     unless defined $anchor;
 847             $it .= $anchor->string;
 848         } else {
 849             die "Completely confused decoding anchors: $fmt\n";#XXX
 850         }
 851     }
 852     return $it;
 853 }
 854
 855 sub charset_canon ($) {
 856     my($charset) = @_;
 857     $charset = uc($charset);
 858     $charset = "$1-$2" if $charset =~ /^(ISO|UTF)(\d.*)/i;
 859     $charset = 'Big5' if $charset eq 'BIG5'; # "Big5" must be in mixed case
 860     return $charset;
 861 }
 862
 863 use vars qw( @latin1_utf8 );
 864 @latin1_utf8 = (
 865     "\302\200", "\302\201", "\302\202", "\302\203", "\302\204", "\302\205",
 866     "\302\206", "\302\207", "\302\210", "\302\211", "\302\212", "\302\213",
 867     "\302\214", "\302\215",   undef,      undef,    "\302\220", "\302\221",
 868     "\302\222", "\302\223", "\302\224", "\302\225", "\302\226", "\302\227",
 869     "\302\230", "\302\231", "\302\232", "\302\233", "\302\234", "\302\235",
 870     "\302\236", "\302\237", "\302\240", "\302\241", "\302\242", "\302\243",
 871     "\302\244", "\302\245", "\302\246", "\302\247", "\302\250", "\302\251",
 872     "\302\252", "\302\253", "\302\254", "\302\255", "\302\256", "\302\257",
 873     "\302\260", "\302\261", "\302\262", "\302\263", "\302\264", "\302\265",
 874     "\302\266", "\302\267", "\302\270", "\302\271", "\302\272", "\302\273",
 875     "\302\274", "\302\275", "\302\276", "\302\277", "\303\200", "\303\201",
 876     "\303\202", "\303\203", "\303\204", "\303\205", "\303\206", "\303\207",
 877     "\303\210", "\303\211", "\303\212", "\303\213", "\303\214", "\303\215",
 878     "\303\216", "\303\217", "\303\220", "\303\221", "\303\222", "\303\223",
 879     "\303\224", "\303\225", "\303\226", "\303\227", "\303\230", "\303\231",
 880     "\303\232", "\303\233", "\303\234", "\303\235", "\303\236", "\303\237",
 881     "\303\240", "\303\241", "\303\242", "\303\243", "\303\244", "\303\245",
 882     "\303\246", "\303\247", "\303\250", "\303\251", "\303\252", "\303\253",
 883     "\303\254", "\303\255", "\303\256", "\303\257", "\303\260", "\303\261",
 884     "\303\262", "\303\263", "\303\264", "\303\265", "\303\266", "\303\267",
 885     "\303\270", "\303\271", "\303\272", "\303\273", "\303\274", "\303\275",
 886     "\303\276", "\303\277" );
 887
 888 sub charset_convert ($$$) {
 889     my($s, $charset_in, $charset_out) = @_;
 890     if ($s !~ /[\200-\377]/s) { # FIXME: don't worry about iso2022 for now
 891         ;
 892     } elsif ($charset_in eq 'ISO-8859-1' && $charset_out eq 'UTF-8') {
 893         $s =~ s/[\200-\377]/ $latin1_utf8[ord($&) - 128] /egs;
 894     } elsif ($charset_in ne $charset_out) {
 895         VerboseWarnings::warn_normal "conversion from $charset_in to $charset_out is not supported\n", undef;
 896     }
 897     return $s;
 898 }
 899
 900 ###############################################################################
 901
 902 =pod
 903
 904 In addition to the basic scanning, this class will also perform
 905 the following:
 906
 907 =over
 908
 909 =item -
 910
 911 Emulation of c-format strings (see below)
 912
 913 =item -
 914
 915 Display of warnings for certain things that affects either the
 916 ability of this class to yield correct output, or things that
 917 are known to cause the original template to cause trouble.
 918
 919 =item -
 920
 921 Automatic correction of some of the things warned about
 922 (e.g., SGML "closed start tag" notation).
 923
 924 =back
 925
 926 =head2 c-format strings emulation
 927
 928 Because English word order is not universal, a simple extraction
 929 of translatable strings may yield some strings like "Accounts for"
 930 or ambiguous strings like "in". This makes the resulting strings
 931 difficult to translate, but does not affect all languages alike.
 932 For example, Chinese (with a somewhat different word order) would
 933 be hit harder, but French would be relatively unaffected.
 934
 935 To overcome this problem, the scanner can be configured to detect
 936 patterns with <TMPL_VAR> directives (as well as certain HTML tags),
 937 and try to construct a larger pattern that will appear in the PO
 938 file as c-format strings with %s placeholders. This additional
 939 step allows the translator to deal with cases where word order
 940 is different (replacing %s with %1$s, %2$s, etc.), or when certain
 941 words will require certain inflectional suffixes in sentences.
 942
 943 Because this is an incompatible change, this mode must be explicitly
 944 turned on using the set_cformat(1) method call.
 945
 946 =head2 The flag characters
 947
 948 The character % is followed by zero or more of the following flags:
 949
 950 =over
 951
 952 =item #
 953
 954 The value comes from HTML <INPUT> elements.
 955 This abuse of the flag character is somewhat reasonable,
 956 since TMPL_VAR and INPUT are both variables, but of different kinds.
 957
 958 =back
 959
 960 =head2 The field width and precision
 961
 962 An optional 0.0 can be specified for %s to specify
 963 that the <TMPL_VAR> should be suppressed.
 964
 965 =head2 The conversion specifier
 966
 967 =over
 968
 969 =item p
 970
 971 Specifies any input field that is neither text nor hidden
 972 (which currently mean radio buttons).
 973 The p conversion specifier is chosen because this does not
 974 evoke any certain sensible data type.
 975
 976 =item S
 977
 978 Specifies a text input field (<INPUT TYPE=TEXT>).
 979 This use of the o conversion specifier is somewhat reasonable,
 980 since text input fields contain values of undeterminable type,
 981 which can be treated as strings.
 982
 983 =item s
 984
 985 Specifies a <TMPL_VAR>.
 986 This use of the o conversion specifier is somewhat reasonable,
 987 since <TMPL_VAR> denotes values of undeterminable type, which
 988 can be treated as strings.
 989
 990 =back
 991
 992 =head1 BUGS
 993
 994 There is no code to save the tag name anywhere in the scanned token.
 995
 996 The use of <AI<i>> to stand for the I<i>th anchor
 997 is not very well thought out.
 998 Some abuse of c-format specifies might have been more appropriate.
 999
1000 =head1 HISTORY
1001
1002 This tokenizer is mostly based
1003 on Ambrose's hideous Perl script known as subst.pl.
1004
1005 =cut
1006
1007 1;