package HTML::Parser; # Copyright 1996-2001, Gisle Aas. # Copyright 1999-2000, Michael A. Chase. # # This library is free software; you can redistribute it and/or # modify it under the same terms as Perl itself. use strict; use vars qw($VERSION @ISA); $VERSION = '3.19'; # $Date: 2001/03/10 04:25:57 $ require HTML::Entities; require DynaLoader; @ISA=qw(DynaLoader); HTML::Parser->bootstrap($VERSION); sub new { my $class = shift; my $self = bless {}, $class; return $self->init(@_); } sub init { my $self = shift; $self->_alloc_pstate; my %arg = @_; my $api_version = delete $arg{api_version} || (@_ ? 3 : 2); if ($api_version >= 4) { require Carp; Carp::croak("API version $api_version not supported " . "by HTML::Parser $VERSION"); } if ($api_version < 3) { # Set up method callbacks compatible with HTML-Parser-2.xx $self->handler(text => "text", "self,text,is_cdata"); $self->handler(end => "end", "self,tagname,text"); $self->handler(process => "process", "self,token0,text"); $self->handler(start => "start", "self,tagname,attr,attrseq,text"); $self->handler(comment => sub { my($self, $tokens) = @_; for (@$tokens) { $self->comment($_); } }, "self,tokens"); $self->handler(declaration => sub { my $self = shift; $self->declaration(substr($_[0], 2, -1)); }, "self,text"); } if (my $h = delete $arg{handlers}) { $h = {@$h} if ref($h) eq "ARRAY"; while (my($event, $cb) = each %$h) { $self->handler($event => @$cb); } } # In the end we try to assume plain attribute or handler while (my($option, $val) = each %arg) { if ($option =~ /^(\w+)_h$/) { $self->handler($1 => @$val); } elsif ($option =~ /^(text|start|end|process|declaration|comment)$/) { require Carp; Carp::croak("Bad constructor option '$option'"); } else { $self->$option($val); } } return $self; } sub parse_file { my($self, $file) = @_; my $opened; if (!ref($file) && ref(\$file) ne "GLOB") { # Assume $file is a filename local(*F); open(F, $file) || return undef; binmode(F); # should we? good for byte counts $opened++; $file = *F; } my $chunk = ''; while (read($file, $chunk, 512)) { $self->parse($chunk) || last; } close($file) if $opened; $self->eof; } sub netscape_buggy_comment # legacy { my $self = shift; if ($^W) { require Carp; Carp::carp("netscape_buggy_comment() is deprecated. " . "Please use the strict_comment() method instead"); } my $old = !$self->strict_comment; $self->strict_comment(!shift) if @_; return $old; } # set up method stubs sub text { } *start = \&text; *end = \&text; *comment = \&text; *declaration = \&text; *process = \&text; 1; __END__ =head1 NAME HTML::Parser - HTML parser class =head1 SYNOPSIS use HTML::Parser (); # Create parser object $p = HTML::Parser->new( api_version => 3, start_h => [\&start, "tagname, attr"], end_h => [\&end, "tagname"], marked_sections => 1, ); # Parse document text chunk by chunk $p->parse($chunk1); $p->parse($chunk2); #... $p->eof; # signal end of document # Parse directly from file $p->parse_file("foo.html"); # or open(F, "foo.html") || die; $p->parse_file(*F); HTML::Parser version 2 style subclassing and method callbacks: { package MyParser; use base 'HTML::Parser'; sub start { my($self, $tagname, $attr, $attrseq, $origtext) = @_; #... } sub end { my($self, $tagname, $origtext) = @_; #... } sub text { my($self, $origtext, $is_cdata) = @_; #... } } my $p = MyParser->new; $p->parse_file("foo.html"); =head1 DESCRIPTION Objects of the C class will recognize markup and separate it from plain text (alias data content) in HTML documents. As different kinds of markup and text are recognized, the corresponding event handlers are invoked. C in not a generic SGML parser. We have tried to make it able to deal with the HTML that is actually "out there", and it normally parses as closely as possible to the way the popular web browsers do it instead of strictly following one of the many HTML specifications from W3C. Where there is disagreement there is often an option that you can enable to get the official behaviour. The document to be parsed may be supplied in arbitrary chunks. This makes on-the-fly parsing as documents are received from the network possible. If event driven parsing does not feel right for your application, you might want to use C. It is a C subclass that allows a more conventional program structure. =head1 METHODS The following method is used to construct a new C object: =over =item $p = HTML::Parser->new( %options_and_handlers ) This class method creates a new C object and returns it. Key/value pair arguments may be provided to assign event handlers or initialize parser options. The handlers and parser options can also be set or modified later by method calls described below. If a top level key is in the form "_h" (e.g., "text_h"} then it assigns a handler to that event, otherwise it initializes a parser option. The event handler specification value must be an array reference. Multiple handlers may also be assigned with the 'handlers => [%handlers]' option. See examples below. If new() is called without any arguments, it will create a parser that uses callback methods compatible with version 2 of C. See the section on "version 2 compatibility" below for details. Special constructor option 'api_version => 2' can be used to initialize version 2 callbacks while still setting other options and handlers. The 'api_version => 3' option can be used if you don't want to set any options and don't want to fall back to v2 compatible mode. Examples: $p = HTML::Parser->new(api_version => 3, text_h => [ sub {...}, "dtext" ]); This creates a new parser object with a text event handler subroutine that receives the original text with general entities decoded. $p = HTML::Parser->new(api_version => 3, start_h => [ 'my_start', "self,tokens" ]); This creates a new parser object with a start event handler method that receives the $p and the tokens array. $p = HTML::Parser->new(api_version => 3, handlers => { text => [\@array, "event,text"], comment => [\@array, "event,text"], }); This creates a new parser object that stores the event type and the original text in @array for text and comment events. =back The following methods feed the HTML document to the C object: =over =item $p->parse( $string ) Parse $string as the next chunk of the HTML document. The return value is normally a reference to the parser object (i.e. $p). Handlers invoked should not attempt modify the $string in-place until $p->parse returns. If an invoked event handler aborts parsing by calling $p->eof, then $p->parse() will return a FALSE value. =item $p->parse_file( $file ) Parse text directly from a file. The $file argument can be a filename, an open file handle, or a reference to a an open file handle. If $file contains a filename and the file can't be opened, then the method returns an undefined value and $! tells why it failed. Otherwise the return value is a reference to the parser object. If a file handle is passed as the $file argument, then the file will normally be read until EOF, but not closed. If an invoked event handler aborts parsing by calling $p->eof, then $p->parse_file() may not have read the entire file. On systems with multi-byte line terminators, the values passed for the offset and length argspecs may be too low if parse_file is called with a file handle that is not in binary mode. =item $p->eof Signals the end of the HTML document. Calling the $p->eof method outside a handler callback will flush any remaining buffered text (which triggers the C event if there is any remaining text). Calling $p->eof inside a handler will terminate parsing at that point and cause $p->parse to return a FALSE value. This also terminates parsing by $p->parse_file(). The return value is a reference to the parser object. =back Most parser options are controlled by boolean attributes. Each boolean attribute is enabled by calling the corresponding method with a TRUE argument and disabled with a FALSE argument. The attribute value is left unchanged if no argument is given. The return value from each method is the old attribute value. Methods that can be used to get and/or set parser options are: =over =item $p->strict_comment( [$bool] ) By default, comments are terminated by the first occurrence of "-->". This is the behaviour of most popular browsers (like Netscape and MSIE), but it is not correct according to the official HTML standard. Officially, you need an even number of "--" tokens before the closing ">" is recognized and there may not be anything but whitespace between an even and an odd "--". The official behaviour is enabled by enabling this attribute. =item $p->strict_names( [$bool] ) By default, almost anything is allowed in tag and attribute names. This is the behaviour of most popular browsers and allows us to parse some broken tags with invalid attr values like: [PREV By default, "LIST]" is parsed as a boolean attribute, not as part of the ALT value as was clearly intended. This is also what Netscape sees. The official behaviour is enabled by enabling this attribute. If enabled, it will cause the tag above to be reported as text since "LIST]" is not a legal attribute name. =item $p->boolean_attribute_value( $val ) This method sets the value reported for boolean attributes inside HTML start tags. By default, the name of the attribute is also used as its value. This affects the values reported for C and C argspecs. =item $p->xml_mode( [$bool] ) Enabling this attribute changes the parser to allow some XML constructs such as I and I. It disables forcing tag and attribute names to lower case when they are reported by the C and C argspecs, and suppress special treatment of elements that are parsed as CDATA for HTML. I look like start tags, but end with the character sequence "/>". When recognized by C they cause an artificial end event in addition to the start event. The C for the artificial end event will be empty and the C array will be undefined even though the only element in the token array will have the correct tag name. I are terminated by "?>" instead of a simple ">" as is the case for HTML. =item $p->unbroken_text( [$bool] ) By default, blocks of text are given to the text handler as soon as possible (but the parser makes sure to always break text at the boundary between whitespace and non-whitespace so single words and entities always can be decoded safely). This might create breaks that make it hard to do transformations on the text. When this attribute is enabled, blocks of text are always reported in one piece. This will delay the text event until the following (non-text) event has been recognized by the parser. =item $p->marked_sections( [$bool] ) By default, section markings like are treated like ordinary text. When this attribute is enabled section markings are honoured. There are currently no events associated with marked section elements. =back As markup and text is recognized, handlers are invoked. The following method is used to set up handlers for different events: =over =item $p->handler( event => \&subroutine, argspec ) =item $p->handler( event => method_name, argspec ) =item $p->handler( event => \@accum, argspec ) =item $p->handler( event => "" ); =item $p->handler( event => undef ); =item $p->handler( event ); This method assigns a subroutine, method, or array to handle an event. Event is one of C, C, C, C, C, C or C. I is a reference to a subroutine which is called to handle the event. I is the name of a method of $p which is called to handle the event. I is a array that will hold the event information as sub-arrays. If the second argument is "", the event is ignored. If it is undef, the default handler is invoked for the event. I is a string that describes the information to be reported for the event. Any requested information that does not apply to a specific event is passed as C. If argspec is omitted, then it is left unchanged since last update. The return value from $p->handle is the old callback routine or a reference to the accumulator array. Return values from handler callback routines/methods are always ignored. A handler callback can request parsing to be aborted by invoking the $p->eof method. A handler callback is not allowed to invoke $p->parse() or $p->parse_file(). Examples: $p->handler(start => "start", 'self, attr, attrseq, text' ); This causes the "start" method of object $p to be called for 'start' events. The callback signature is $p->start(\%attr, \@attr_seq, $text). $p->handler(start => \&start, 'attr, attrseq, text' ); This causes subroutine start() to be called for 'start' events. The callback signature is start(\%attr, \@attr_seq, $text). $p->handler(start => \@accum, '"S", attr, attrseq, text' ); This causes 'start' event information to be saved in @accum. The array elements will be ['S', \%attr, \@attr_seq, $text]. $p->handler(start => ""); This causes 'start' events to be ignored. It also supresses invokations of any default handler for start events. It is equivalent to $p->handler(start => sub {}), but is more efficient. $p->handler(start => undef); This causes no handler to be assosiated with start events. If there is a default handler it will be invoked. =back =head2 Argspec Argspec is a string containing a comma separated list that describes the information reported by the event. The following argspec identifier names can be used: =over =item C Self causes the current object to be passed to the handler. If the handler is a method, this must be the first element in the argspec. =item C Tokens causes a reference to an array of token strings to be passed. The strings are exactly as they were found in the original text, no decoding or case changes are applied. For C events, the array contains each word, comment, and delimited string starting with the declaration type. For C events, this contains each sub-comment. If $p->strict_comments is disabled, there will be only one sub-comment. For C events, this contains the original tag name followed by the attribute name/value pairs. The value of boolean attributes will be either the value set by $p->boolean_attribute_value or the attribute name if no value has been set by $p->boolean_attribute_value. For C events, this contains the original tag name (one token only). For C events, this contains the process instructions (one token only). This passes C for C events. =item C Tokenpos causes a reference to an array of token positions to be passed. For each string that appears in C, this array contains two numbers. The first number is the offset of the start of the token in the original C and the second number is the length of the token. Boolean attributes in a C event will have (0,0) for the attribute value offset and length. This passes undef if there are no tokens in the event (e.g., C) and for artifical C events triggered by empty element tags. If you are using these offsets and lengths to modify C, you should either work from right to left, or be very careful to calculate the changes to the offsets. =item C Token0 causes the original text of the first token string to be passed. This should always be the same as $tokens->[0]. For C events, this is the declaration type. For C and C events, this is the tag name. For C and non-strict C events, this is everything inside the tag. This passes undef if there are no tokens in the event. =item C This is the element name (or I in SGML jargon) for start and end tags. Since HTML is case insensitive this name is forced to lower case to ease string matching. Since XML is case sensitive, the tagname case is not changed when C is enabled. The declaration type of declaration elements is also passed as a tagname, even if that is a bit strange. In fact, in the current implementation tagname is identical to C except that the name may be forced to lower case. =item C Attr causes a reference to a hash of attribute name/value pairs to be passed. Boolean attributes' values are either the value set by $p->boolean_attribute_value or the attribute name if no value has been set by $p->boolean_attribute_value. This passes undef except for C events. Unless C is enabled, the attribute names are forced to lower case. General entities are decoded in the attribute values and one layer of matching quotes enclosing the attribute values are removed. =item C Attrseq causes a reference to an array of attribute names to be passed. This can be useful if you want to walk the C hash in the original sequence. This passes undef except for C events. Unless C is enabled, the attribute names are forced to lower case. =item C Text causes the source text (including markup element delimiters) to be passed. =item C Dtext causes the decoded text to be passed. General entities are automatically decoded unless the event was inside a CDATA section or was between literal start and end tags (C