名前¶

LWP::RobotUA - よい振る舞いをする Web ロボットのためのクラス

概要¶

  use LWP::RobotUA;
  my $ua = LWP::RobotUA->new('my-robot/0.1', 'me@foo.com');
  $ua->delay(10);  # be very nice -- max one hit every ten minutes!
  ...

  # Then just use it just like a normal LWP::UserAgent:
  my $response = $ua->get('http://whatever.int/...');
  ...

説明¶

このクラスはロボットアプリケーションに適したユーザーエージェントを実装します。 ロボットは訪れるサーバにとってナイスでなければなりません。 それらは /robots.txt を見て歓迎されていることを確認しなければなりません。 そしてあまり頻繁にリクエストしてはいけません。

しかし、ロボットを書くことを考える前に <URL:http://www.robotstxt.org/> を見てください。

LWP::RobotUA をあなたのユーザーエージェントとして使うとき、 実際の所これらのことについて考える必要はありません; 自動的に robots.txt ファイルを参考にしてそれに従い、サーバにあまり 急激に問い合わせず、など。 通常の LWP::UserAgent を使って ($ua->get(...), $ua->head(...), $ua->request(...) などを使って) 好きなように単純にリクエストを送信すれば、 この特別なエージェントはいい感じになることを保証します。

メソッド¶

LWP::RobotUA は LWP::UserAgent のサブクラスで、同じメソッドを実装しています。 さらに以下のメソッドも提供されます:

$ua = LWP::RobotUA->new( %options )

$ua = LWP::RobotUA->new( $agent, $from )

$ua = LWP::RobotUA->new( $agent, $from, $rules )

The LWP::UserAgent options agent and from are mandatory. The options delay, use_sleep and rules initialize attributes private to the RobotUA. If rules are not provided, then WWW::RobotRules is instantiated providing an internal database of robots.txt.

LWP::UserAgent のオプション agent と from は必須です。 オプション delay, use_sleep, rules は RobotUA 独自の 属性を初期化します。 rules が提供されない場合、WWW::RobotRules は robots.txt の内部データベースを使って実体化されます。

It is also possible to just pass the value of agent, from and optionally rules as plain positional arguments.

また、単に agent, from (およびオプションとして rules) を 通常の順序付き引数として渡すこともできます。

$ua->delay

$ua->delay( $minutes )

Get/set the minimum delay between requests to the same server, in minutes. The default is 1 minute. Note that this number doesn't have to be an integer; for example, this sets the delay to 10 seconds:

同じサーバへのリクエスト間の最小限の遅延(秒単位)を設定/取得します。 デフォルトは 1 分です。 この数値は整数である必要はないことに注意してください; 例えば、 以下のように設定すると 10 秒遅延します:

    $ua->delay(10/60);

$ua->use_sleep

$ua->use_sleep( $boolean )

Get/set a value indicating whether the UA should sleep() if requests arrive too fast, defined as $ua->delay minutes not passed since last request to the given server. The default is TRUE. If this value is FALSE then an internal SERVICE_UNAVAILABLE response will be generated. It will have an Retry-After header that indicates when it is OK to send another request to this server.

リクエストの到着があまりに早い (与えられたサーバーへの最後の リクエストから $ua->delay 分が経過していないかどうかで決定されます) とき、 UA が sleep() するべきかどうかを示す値を取得／設定します。 デフォルトは真です。 もしこの値が偽であれば、内部の SERVICE_UNAVAILABLE が生成されます。 このサーバに次のリクエストを送信することがいつになったら OK かを示す、 Retry-After ヘッダを持ちます。

$ua->rules

$ua->rules( $rules )

Set/get which WWW::RobotRules object to use.

使用する WWW::RobotRules オブジェクトの設定／取得します。

$ua->no_visits( $netloc )

Returns the number of documents fetched from this server host. Yeah I know, this method should probably have been named num_visits() or something like that. :-(

このサーバーホストから取り出されたドキュメントの数を返します。 このメソッドが num_visits() とかなんとか名付けられるべきだってことは、 わかっていますってば。:-(

$ua->host_wait( $netloc )

Returns the number of seconds (from now) you must wait before you can make a new request to this host.

このホストへ新しいリクエストをすることができるまで、(今から) 何秒 待たなければならないかを返します。

$ua->as_string

Returns a string that describes the state of the UA. Mainly useful for debugging.

UA の状態を示す文字列を返します。 主にデバッグに役立ちます。

SEE ALSO¶

LWP::UserAgent, WWW::RobotRules

コピーライト¶

Copyright 1996-2004 Gisle Aas.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.