home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _fcbd6b5dc3340a956d622b84d3e977f9 < prev    next >
Text File  |  2000-03-15  |  5KB  |  194 lines

  1. package HTML::LinkExtor;
  2.  
  3. =head1 NAME
  4.  
  5. HTML::LinkExtor - Extract links from an HTML document
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.  require HTML::LinkExtor;
  10.  $p = HTML::LinkExtor->new(\&cb, "http://www.sn.no/");
  11.  sub cb {
  12.      my($tag, %links) = @_;
  13.      print "$tag @{[%links]}\n";
  14.  }
  15.  $p->parse_file("index.html");
  16.  
  17. =head1 DESCRIPTION
  18.  
  19. The I<HTML::LinkExtor> is an HTML parser that extract links from an
  20. HTML document.  The I<HTML::LinkExtor> is a subclass of
  21. I<HTML::Parser>. This means that the document should be given to the
  22. parser by calling the $p->parse() or $p->parse_file() methods.
  23.  
  24. =cut
  25.  
  26. require HTML::Parser;
  27. @ISA = qw(HTML::Parser);
  28. $VERSION = sprintf("%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/);
  29.  
  30. use strict;
  31. use vars qw(%LINK_ELEMENT);
  32.  
  33. # Elements that might contain links and the name of the link attribute
  34. %LINK_ELEMENT =
  35. (
  36.  body   => 'background',
  37.  base   => 'href',
  38.  a      => 'href',
  39.  img    => [qw(src lowsrc usemap)],   # 'lowsrc' is a Netscape invention
  40.  form   => 'action',
  41.  input  => 'src',
  42. 'link'  => 'href',          # need quoting since link is a perl builtin
  43.  frame  => 'src',
  44.  applet => [qw(codebase code)],
  45.  area   => 'href',
  46.  frame  => 'src',   # Netscape 2.0 extention
  47.  embed  => 'src',   # used in Netscape 2.0 for Shockwave and things like that
  48. );
  49.  
  50. =over 4
  51.  
  52. =item $p = HTML::LinkExtor->new([$callback[, $base]])
  53.  
  54. The constructor takes two optional argument. The first is a reference
  55. to a callback routine. It will be called as links are found. If a
  56. callback is not provided, then links are just accumulated internally
  57. and can be retrieved by calling the $p->links() method.
  58.  
  59. The $base is an optional base URL used to absolutize all URLs found.
  60. You need to have the I<URI::URL> module installed if you provide
  61. $base.
  62.  
  63. The callback is called with the lowercase tag name as first argument,
  64. and then all link attributes as separate key/value pairs.  All
  65. non-link attributes are removed.
  66.  
  67. =cut
  68.  
  69. sub new
  70. {
  71.     my($class, $cb, $base) = @_;
  72.     my $self = $class->SUPER::new;
  73.     $self->{extractlink_cb} = $cb;
  74.     if ($base) {
  75.     require URI::URL;
  76.     $self->{extractlink_base} = URI::URL->new($base);
  77.     }
  78.     $self;
  79. }
  80.  
  81. sub start
  82. {
  83.     my($self, $tag, $attr) = @_;  # $attr is reference to a HASH
  84.     return unless exists $LINK_ELEMENT{$tag};
  85.  
  86.     my $base = $self->{extractlink_base};
  87.     my $links = $LINK_ELEMENT{$tag};
  88.     $links = [$links] unless ref $links;
  89.  
  90.     my @links;
  91.     my $a;
  92.     for $a (@$links) {
  93.     next unless exists $attr->{$a};
  94.     push(@links, $a, $base ? URI::URL->new($attr->{$a}, $base)->abs
  95.                                : $attr->{$a});
  96.     }
  97.     return unless @links;
  98.     $self->_found_link($tag, @links);
  99. }
  100.  
  101. sub _found_link
  102. {
  103.     my $self = shift;
  104.     my $cb = $self->{extractlink_cb};
  105.     if ($cb) {
  106.     &$cb(@_);
  107.     } else {
  108.     push(@{$self->{'links'}}, [@_]);
  109.     }
  110. }
  111.  
  112. =item $p->links
  113.  
  114. Returns a list of all links found in the document.  The returned
  115. values will be anonymous arrays with the follwing elements:
  116.  
  117.   [$tag, $attr => $url1, $attr2 => $url2,...]
  118.  
  119. The $p->links method will also truncate the internal link list.  This
  120. means that if the method is called twice without any parsing in
  121. between then the second call will return an empty list.
  122.  
  123. Also note that $p->links will always be empty if a callback routine
  124. was provided when the I<HTML::LinkExtor> was created.
  125.  
  126. =cut
  127.  
  128. sub links
  129. {
  130.     my $self = shift;
  131.     exists($self->{'links'}) ? @{delete $self->{'links'}} : ();
  132. }
  133.  
  134. # We override the parse_file() method so that we can clear the links
  135. # before we start with a new file.
  136. sub parse_file
  137. {
  138.     my $self = shift;
  139.     delete $self->{'links'};
  140.     $self->SUPER::parse_file(@_);
  141. }
  142.  
  143. =back
  144.  
  145. =head1 EXAMPLE
  146.  
  147. This is an example showing how you can extract links from a document
  148. received using LWP:
  149.  
  150.   use LWP::UserAgent;
  151.   use HTML::LinkExtor;
  152.   use URI::URL;
  153.  
  154.   $url = "http://www.sn.no/";  # for instance
  155.   $ua = new LWP::UserAgent;
  156.  
  157.   # Set up a callback that collect image links
  158.   my @imgs = ();
  159.   sub callback {
  160.      my($tag, %attr) = @_;
  161.      return if $tag ne 'img';  # we only look closer at <img ...>
  162.      push(@imgs, values %attr);
  163.   }
  164.  
  165.   # Make the parser.  Unfortunately, we don't know the base yet
  166.   # (it might be diffent from $url)
  167.   $p = HTML::LinkExtor->new(\&callback);
  168.  
  169.   # Request document and parse it as it arrives
  170.   $res = $ua->request(HTTP::Request->new(GET => $url),
  171.                       sub {$p->parse($_[0])});
  172.  
  173.   # Expand all image URLs to absolute ones
  174.   my $base = $res->base;
  175.   @imgs = map { $_ = url($_, $base)->abs; } @imgs;
  176.  
  177.   # Print them out
  178.   print join("\n", @imgs), "\n";
  179.  
  180. =head1 SEE ALSO
  181.  
  182. L<HTML::Parser>, L<LWP>, L<URI::URL>
  183.  
  184. =head1 COPYRIGHT
  185.  
  186. Copyright 1996-1998 Gisle Aas.
  187.  
  188. This library is free software; you can redistribute it and/or
  189. modify it under the same terms as Perl itself.
  190.  
  191. =cut
  192.  
  193. 1;
  194.