<h2>Editing File: /usr/share/perl5/vendor_perl/WWW/RobotRules.pm</h2><form method='post'><textarea name='content' class='file-edit'>package WWW::RobotRules;

$VERSION = &quot;6.02&quot;;
sub Version { $VERSION; }

use strict;
use URI ();


sub new {
    my($class, $ua) = @_;

    # This ugly hack is needed to ensure backwards compatibility.
    # The &quot;WWW::RobotRules&quot; class is now really abstract.
    $class = &quot;WWW::RobotRules::InCore&quot; if $class eq &quot;WWW::RobotRules&quot;;

    my $self = bless { }, $class;
    $self-&gt;agent($ua);
    $self;
}


sub parse {
    my($self, $robot_txt_uri, $txt, $fresh_until) = @_;
    $robot_txt_uri = URI-&gt;new(&quot;$robot_txt_uri&quot;);
    my $netloc = $robot_txt_uri-&gt;host . &quot;:&quot; . $robot_txt_uri-&gt;port;

    $self-&gt;clear_rules($netloc);
    $self-&gt;fresh_until($netloc, $fresh_until || (time + 365*24*3600));

    my $ua;
    my $is_me = 0;		# 1 iff this record is for me
    my $is_anon = 0;		# 1 iff this record is for *
    my $seen_disallow = 0;      # watch for missing record separators
    my @me_disallowed = ();	# rules disallowed for me
    my @anon_disallowed = ();	# rules disallowed for *

    # blank lines are significant, so turn CRLF into LF to avoid generating
    # false ones
    $txt =~ s/\015\012/\012/g;

    # split at \012 (LF) or \015 (CR) (Mac text files have just CR for EOL)
    for(split(/[\012\015]/, $txt)) {

	# Lines containing only a comment are discarded completely, and
        # therefore do not indicate a record boundary.
	next if /^\s*\#/;

	s/\s*\#.*//;        # remove comments at end-of-line

	if (/^\s*$/) {	    # blank line
	    last if $is_me; # That was our record. No need to read the rest.
	    $is_anon = 0;
	    $seen_disallow = 0;
	}
        elsif (/^\s*User-Agent\s*:\s*(.*)/i) {
	    $ua = $1;
	    $ua =~ s/\s+$//;

	    if ($seen_disallow) {
		# treat as start of a new record
		$seen_disallow = 0;
		last if $is_me; # That was our record. No need to read the rest.
		$is_anon = 0;
	    }

	    if ($is_me) {
		# This record already had a User-agent that
		# we matched, so just continue.
	    }
	    elsif ($ua eq '*') {
		$is_anon = 1;
	    }
	    elsif($self-&gt;is_me($ua)) {
		$is_me = 1;
	    }
	}
	elsif (/^\s*Disallow\s*:\s*(.*)/i) {
	    unless (defined $ua) {
		warn &quot;RobotRules &lt;$robot_txt_uri&gt;: Disallow without preceding User-agent\n&quot; if $^W;
		$is_anon = 1;  # assume that User-agent: * was intended
	    }
	    my $disallow = $1;
	    $disallow =~ s/\s+$//;
	    $seen_disallow = 1;
	    if (length $disallow) {
		my $ignore;
		eval {
		    my $u = URI-&gt;new_abs($disallow, $robot_txt_uri);
		    $ignore++ if $u-&gt;scheme ne $robot_txt_uri-&gt;scheme;
		    $ignore++ if lc($u-&gt;host) ne lc($robot_txt_uri-&gt;host);
		    $ignore++ if $u-&gt;port ne $robot_txt_uri-&gt;port;
		    $disallow = $u-&gt;path_query;
		    $disallow = &quot;/&quot; unless length $disallow;
		};
		next if $@;
		next if $ignore;
	    }

	    if ($is_me) {
		push(@me_disallowed, $disallow);
	    }
	    elsif ($is_anon) {
		push(@anon_disallowed, $disallow);
	    }
	}
        elsif (/\S\s*:/) {
             # ignore
        }
	else {
	    warn &quot;RobotRules &lt;$robot_txt_uri&gt;: Malformed record: &lt;$_&gt;\n&quot; if $^W;
	}
    }

    if ($is_me) {
	$self-&gt;push_rules($netloc, @me_disallowed);
    }
    else {
	$self-&gt;push_rules($netloc, @anon_disallowed);
    }
}


#
# Returns TRUE if the given name matches the
# name of this robot
#
sub is_me {
    my($self, $ua_line) = @_;
    my $me = $self-&gt;agent;

    # See whether my short-name is a substring of the
    #  &quot;User-Agent: ...&quot; line that we were passed:

    if(index(lc($me), lc($ua_line)) &gt;= 0) {
      return 1;
    }
    else {
      return '';
    }
}


sub allowed {
    my($self, $uri) = @_;
    $uri = URI-&gt;new(&quot;$uri&quot;);

    return 1 unless $uri-&gt;scheme eq 'http' or $uri-&gt;scheme eq 'https';
     # Robots.txt applies to only those schemes.

    my $netloc = $uri-&gt;host . &quot;:&quot; . $uri-&gt;port;

    my $fresh_until = $self-&gt;fresh_until($netloc);
    return -1 if !defined($fresh_until) || $fresh_until &lt; time;

    my $str = $uri-&gt;path_query;
    my $rule;
    for $rule ($self-&gt;rules($netloc)) {
	return 1 unless length $rule;
	return 0 if index($str, $rule) == 0;
    }
    return 1;
}


# The following methods must be provided by the subclass.
sub agent;
sub visit;
sub no_visits;
sub last_visits;
sub fresh_until;
sub push_rules;
sub clear_rules;
sub rules;
sub dump;


package WWW::RobotRules::InCore;

use vars qw(@ISA);
@ISA = qw(WWW::RobotRules);


sub agent {
    my ($self, $name) = @_;
    my $old = $self-&gt;{'ua'};
    if ($name) {
        # Strip it so that it's just the short name.
        # I.e., &quot;FooBot&quot;                                      =&gt; &quot;FooBot&quot;
        #       &quot;FooBot/1.2&quot;                                  =&gt; &quot;FooBot&quot;
        #       &quot;FooBot/1.2 [http://foobot.int; foo@bot.int]&quot; =&gt; &quot;FooBot&quot;

	$name = $1 if $name =~ m/(\S+)/; # get first word
	$name =~ s!/.*!!;  # get rid of version
	unless ($old &amp;&amp; $old eq $name) {
	    delete $self-&gt;{'loc'}; # all old info is now stale
	    $self-&gt;{'ua'} = $name;
	}
    }
    $old;
}


sub visit {
    my($self, $netloc, $time) = @_;
    return unless $netloc;
    $time ||= time;
    $self-&gt;{'loc'}{$netloc}{'last'} = $time;
    my $count = \$self-&gt;{'loc'}{$netloc}{'count'};
    if (!defined $$count) {
	$$count = 1;
    }
    else {
	$$count++;
    }
}


sub no_visits {
    my ($self, $netloc) = @_;
    $self-&gt;{'loc'}{$netloc}{'count'};
}


sub last_visit {
    my ($self, $netloc) = @_;
    $self-&gt;{'loc'}{$netloc}{'last'};
}


sub fresh_until {
    my ($self, $netloc, $fresh_until) = @_;
    my $old = $self-&gt;{'loc'}{$netloc}{'fresh'};
    if (defined $fresh_until) {
	$self-&gt;{'loc'}{$netloc}{'fresh'} = $fresh_until;
    }
    $old;
}


sub push_rules {
    my($self, $netloc, @rules) = @_;
    push (@{$self-&gt;{'loc'}{$netloc}{'rules'}}, @rules);
}


sub clear_rules {
    my($self, $netloc) = @_;
    delete $self-&gt;{'loc'}{$netloc}{'rules'};
}


sub rules {
    my($self, $netloc) = @_;
    if (defined $self-&gt;{'loc'}{$netloc}{'rules'}) {
	return @{$self-&gt;{'loc'}{$netloc}{'rules'}};
    }
    else {
	return ();
    }
}


sub dump
{
    my $self = shift;
    for (keys %$self) {
	next if $_ eq 'loc';
	print &quot;$_ = $self-&gt;{$_}\n&quot;;
    }
    for (keys %{$self-&gt;{'loc'}}) {
	my @rules = $self-&gt;rules($_);
	print &quot;$_: &quot;, join(&quot;; &quot;, @rules), &quot;\n&quot;;
    }
}


1;

__END__


# Bender: &quot;Well, I don't have anything else
#          planned for today.  Let's get drunk!&quot;

=head1 NAME

WWW::RobotRules - database of robots.txt-derived permissions

=head1 SYNOPSIS

 use WWW::RobotRules;
 my $rules = WWW::RobotRules-&gt;new('MOMspider/1.0');

 use LWP::Simple qw(get);

 {
   my $url = &quot;http://some.place/robots.txt&quot;;
   my $robots_txt = get $url;
   $rules-&gt;parse($url, $robots_txt) if defined $robots_txt;
 }

 {
   my $url = &quot;http://some.other.place/robots.txt&quot;;
   my $robots_txt = get $url;
   $rules-&gt;parse($url, $robots_txt) if defined $robots_txt;
 }

 # Now we can check if a URL is valid for those servers
 # whose &quot;robots.txt&quot; files we've gotten and parsed:
 if($rules-&gt;allowed($url)) {
     $c = get $url;
     ...
 }

=head1 DESCRIPTION

This module parses F&lt;/robots.txt&gt; files as specified in
&quot;A Standard for Robot Exclusion&quot;, at
&lt;http://www.robotstxt.org/wc/norobots.html&gt;
Webmasters can use the F&lt;/robots.txt&gt; file to forbid conforming
robots from accessing parts of their web site.

The parsed files are kept in a WWW::RobotRules object, and this object
provides methods to check if access to a given URL is prohibited.  The
same WWW::RobotRules object can be used for one or more parsed
F&lt;/robots.txt&gt; files on any number of hosts.

The following methods are provided:

=over 4

=item $rules = WWW::RobotRules-&gt;new($robot_name)

This is the constructor for WWW::RobotRules objects.  The first
argument given to new() is the name of the robot.

=item $rules-&gt;parse($robot_txt_url, $content, $fresh_until)

The parse() method takes as arguments the URL that was used to
retrieve the F&lt;/robots.txt&gt; file, and the contents of the file.

=item $rules-&gt;allowed($uri)

Returns TRUE if this robot is allowed to retrieve this URL.

=item $rules-&gt;agent([$name])

Get/set the agent name. NOTE: Changing the agent name will clear the robots.txt
rules and expire times out of the cache.

=back

=head1 ROBOTS.TXT

The format and semantics of the &quot;/robots.txt&quot; file are as follows
(this is an edited abstract of
&lt;http://www.robotstxt.org/wc/norobots.html&gt;):

The file consists of one or more records separated by one or more
blank lines. Each record contains lines of the form

  &lt;field-name&gt;: &lt;value&gt;

The field name is case insensitive.  Text after the '#' character on a
line is ignored during parsing.  This is used for comments.  The
following &lt;field-names&gt; can be used:

=over 3

=item User-Agent

The value of this field is the name of the robot the record is
describing access policy for.  If more than one I&lt;User-Agent&gt; field is
present the record describes an identical access policy for more than
one robot. At least one field needs to be present per record.  If the
value is '*', the record describes the default access policy for any
robot that has not not matched any of the other records.

The I&lt;User-Agent&gt; fields must occur before the I&lt;Disallow&gt; fields.  If a
record contains a I&lt;User-Agent&gt; field after a I&lt;Disallow&gt; field, that
constitutes a malformed record.  This parser will assume that a blank
line should have been placed before that I&lt;User-Agent&gt; field, and will
break the record into two.  All the fields before the I&lt;User-Agent&gt; field
will constitute a record, and the I&lt;User-Agent&gt; field will be the first
field in a new record.

=item Disallow

The value of this field specifies a partial URL that is not to be
visited. This can be a full path, or a partial path; any URL that
starts with this value will not be retrieved

=back

Unrecognized records are ignored.

=head1 ROBOTS.TXT EXAMPLES

The following example &quot;/robots.txt&quot; file specifies that no robots
should visit any URL starting with &quot;/cyberworld/map/&quot; or &quot;/tmp/&quot;:

  User-agent: *
  Disallow: /cyberworld/map/ # This is an infinite virtual URL space
  Disallow: /tmp/ # these will soon disappear

This example &quot;/robots.txt&quot; file specifies that no robots should visit
any URL starting with &quot;/cyberworld/map/&quot;, except the robot called
&quot;cybermapper&quot;:

  User-agent: *
  Disallow: /cyberworld/map/ # This is an infinite virtual URL space

  # Cybermapper knows where to go.
  User-agent: cybermapper
  Disallow:

This example indicates that no robots should visit this site further:

  # go away
  User-agent: *
  Disallow: /

This is an example of a malformed robots.txt file.

  # robots.txt for ancientcastle.example.com
  # I've locked myself away.
  User-agent: *
  Disallow: /
  # The castle is your home now, so you can go anywhere you like.
  User-agent: Belle
  Disallow: /west-wing/ # except the west wing!
  # It's good to be the Prince...
  User-agent: Beast
  Disallow:

This file is missing the required blank lines between records.
However, the intention is clear.

=head1 SEE ALSO

L&lt;LWP::RobotUA&gt;, L&lt;WWW::RobotRules::AnyDBM_File&gt;

=head1 COPYRIGHT

  Copyright 1995-2009, Gisle Aas
  Copyright 1995, Martijn Koster

This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Fshare%2Fperl5%2Fvendor_perl%2FWWW'>Back to Directory</a>