lwptut -- An LWP Tutorial

lwptut -- LWP のチュートリアル


LWP (short for "Library for WWW in Perl") is a very popular group of Perl modules for accessing data on the Web. Like most Perl module-distributions, each of LWP's component modules comes with documentation that is a complete reference to its interface. However, there are so many modules in LWP that it's hard to know where to start looking for information on how to do even the simplest most common things.

LWP ("Library for WWW in Perl" の短縮形) は、Web 上のデータに アクセスするための非常に有名な Perl モジュール群です。 ほとんどの Perl モジュール配布と同様、LWP のコンポーネントモジュールの それぞれには完全なインターフェースのリファレンス文書が同梱されています。 しかし、LWP にはたくさんのモジュールがあるので、最も単純で最も一般的な ことをするための情報ですら、どこから探せばよいのかがわかりにくいです。

Really introducing you to using LWP would require a whole book -- a book that just happens to exist, called Perl & LWP. But this article should give you a taste of how you can go about some common tasks with LWP.

LWP の使い方を説明するには本 1 冊が必要です -- たまたま Perl & LWP という 本があります。 しかし、この記事は LWP でいくつかの一般的な作業をする方法のさわりを 説明します。

LWP::Simple を使って文書を取得する

If you just want to get what's at a particular URL, the simplest way to do it is LWP::Simple's functions.

単に特定の URL の内容を取得したいなら、最も簡単な方法は LWP::Simple の関数を使うことです。

In a Perl program, you can call its get($url) function. It will try getting that URL's content. If it works, then it'll return the content; but if there's some error, it'll return undef.

Perl プログラム中で、このモジュールの get($url) 関数を呼び出します。 これは指定された URL の内容を取得しようとします。 うまく行けば、内容を返します; しかし、もし何かエラーが起これば、 未定義値を返します。

  my $url = '';
    # Just an example: the URL for the most recent /Fresh Air/ show

  use LWP::Simple;
  my $content = get $url;
  die "Couldn't get $url" unless defined $content;

  # Then go do things with $content, like this:

  if($content =~ m/jazz/i) {
    print "They're talking about jazz today on Fresh Air!\n";
  else {
    print "Fresh Air is apparently jazzless today.\n";

The handiest variant on get is getprint, which is useful in Perl one-liners. If it can get the page whose URL you provide, it sends it to STDOUT; otherwise it complains to STDERR.

最も便利な get のバリエーションは getprint で、Perl 1行野郎で 有用です。 指定した URL からページを取得できれば、内容を STDOUT に出力します; さもなければ STDERR にエラーを出力します。

  % perl -MLWP::Simple -e "getprint ''"

That is the URL of a plaintext file that lists new files in CPAN in the past two weeks. You can easily make it part of a tidy little shell command, like this one that mails you the list of new Acme:: modules:

これは CPAN 内の過去 2 週間の新規ファイルの一覧のプレーンテキストファイルの URL です。 これによってちょっとしたシェルコマンドの一部として使えます; 例えば 新しい Acme:: モジュールの一覧をメールするには:

  % perl -MLWP::Simple -e "getprint ''"  \
     | grep "/by-module/Acme" | mail -s "New Acme modules! Joy!" $USER

There are other useful functions in LWP::Simple, including one function for running a HEAD request on a URL (useful for checking links, or getting the last-revised time of a URL), and two functions for saving/mirroring a URL to a local file. See the LWP::Simple documentation for the full details, or chapter 2 of Perl & LWP for more examples.

LWP::Simple にはその他にも便利な関数があります; URL に HEAD リクエストを 送る関数 (リンクのチェックや、ある URL の最終更新日時の取得に便利です) や、 URL の内容をローカルファイルに保存/ミラーするための二つの関数などです。 完全な詳細については LWP::Simple の文書 、 更なる例については Perl & LWP の第 2 章を参照してください。

LWP クラスモデルの基本

LWP::Simple's functions are handy for simple cases, but its functions don't support cookies or authorization, don't support setting header lines in the HTTP request, generally don't support reading header lines in the HTTP response (notably the full HTTP error message, in case of an error). To get at all those features, you'll have to use the full LWP class model.

LWP::Simple の関数は単純な状況では便利ですが、この関数はクッキーや認証に 対応していませんし、HTTP リクエストのヘッダ行の設定にも対応しませんし、 一般的には HTTP レスポンスのヘッダ行の読み込み(特に、エラー時の 完全な HTTP エラーメッセージ)も対応していません。 これらの機能全てを使うには、完全な LWP クラスモデルを使う必要があります。

While LWP consists of dozens of classes, the main two that you have to understand are LWP::UserAgent and HTTP::Response. LWP::UserAgent is a class for "virtual browsers" which you use for performing requests, and HTTP::Response is a class for the responses (or error messages) that you get back from those requests.

LWP は数十のクラスで構成されていますが、理解する必要がある主な二つのものは LWP::UserAgentHTTP::Response です。 LWP::UserAgent はリクエストを実行するときに使う「仮想ブラウザ」で、 HTTP::Response はそのリクエストから返されたレスポンス(あるいは エラーメッセージ) のためのクラスです。

The basic idiom is $response = $browser->get($url), or more fully illustrated:

基本的な慣用法は $response = $browser->get($url) で、もう少し 完全に示すと:

  # Early in your program:
  use LWP 5.64; # Loads all important LWP classes, and makes
                #  sure your version is reasonably recent.

  my $browser = LWP::UserAgent->new;
  # Then later, whenever you need to make a get request:
  my $url = '';
  my $response = $browser->get( $url );
  die "Can't get $url -- ", $response->status_line
   unless $response->is_success;

  die "Hey, I was expecting HTML, not ", $response->content_type
   unless $response->content_type eq 'text/html';
     # or whatever content-type you're equipped to deal with

  # Otherwise, process the content somehow:
  if($response->decoded_content =~ m/jazz/i) {
    print "They're talking about jazz today on Fresh Air!\n";
  else {
    print "Fresh Air is apparently jazzless today.\n";

There are two objects involved: $browser, which holds an object of class LWP::UserAgent, and then the $response object, which is of class HTTP::Response. You really need only one browser object per program; but every time you make a request, you get back a new HTTP::Response object, which will have some interesting attributes:

二つのオブジェクトが関わっています: $browser は LWP::UserAgent クラスの オブジェクトを保持し、$response オブジェクトは HTTP::Response クラスです。 本当に必要なブラウザオブジェクトは 1 プログラム中に一つだけです; しかしリクエストを出す毎に新しい HTTP::Response オブジェクトが返され、 これにはいくつかの興味深い属性を保持しています:

  • A status code indicating success or failure (which you can test with $response->is_success).

    成功か失敗かを示しているステータスコード($response->is_success で テストできます)。

  • An HTTP status line that is hopefully informative if there's failure (which you can see with $response->status_line, returning something like "404 Not Found").

    失敗したときの情報になるかもしれない HTTP ステータス行 ($response->status_line で見ることができ、"404 Not Found" の ようなものが返されます)。

  • A MIME content-type like "text/html", "image/gif", "application/xml", etc., which you can see with $response->content_type

    "text/html", "image/gif", "application/xml" のような MIME コンテントタイプ; $response->content_type で見ることができます。

  • The actual content of the response, in $response->decoded_content. If the response is HTML, that's where the HTML source will be; if it's a GIF, then $response->decoded_content will be the binary GIF data.

    $response->decoded_content にあるレスポンスの実際の内容。 レスポンスが HTML の場合、ここが HTML ソースが入っている場所です; GIF の場合、$response->decoded_content は GIF データバイナリです。

  • And dozens of other convenient and more specific methods that are documented in the docs for HTML::Response, and its superclasses HTML::Message and HTML::Headers.

    そしてたくさんのその他の便利でより特有のメソッドは、 HTML::Response およびそのスーパークラスである HTML::MessageHTML::Headers の文書で文書化されています。

その他の HTTP リクエストヘッダを追加する

The most commonly used syntax for requests is $response = $browser->get($url), but in truth, you can add extra HTTP header lines to the request by adding a list of key-value pairs after the URL, like so:

リクエストのための最も一般的な使い方の文法は $response = $browser->get($url) ですが、実際の所、以下のように、 URL の後にキー/値の組のリストを追加することで追加の HTTP ヘッダを 追加できます:

  $response = $browser->get( $url, $key1, $value1, $key2, $value2, ... );

For example, here's how to send some more Netscape-like headers, in case you're dealing with a site that would otherwise reject your request:

例えば、Netscape 風のヘッダなしではリクエストを拒否するサイトを扱うために そのようなヘッダを追加するには:

  my @ns_headers = (
   'User-Agent' => 'Mozilla/4.76 [en] (Win98; U)',
   'Accept' => 'image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */*',
   'Accept-Charset' => 'iso-8859-1,*,utf-8',
   'Accept-Language' => 'en-US',

  $response = $browser->get($url, @ns_headers);

If you weren't reusing that array, you could just go ahead and do this:


  $response = $browser->get($url,
   'User-Agent' => 'Mozilla/4.76 [en] (Win98; U)',
   'Accept' => 'image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, image/png, */*',
   'Accept-Charset' => 'iso-8859-1,*,utf-8',
   'Accept-Language' => 'en-US',

If you were only ever changing the 'User-Agent' line, you could just change the $browser object's default line from "libwww-perl/5.65" (or the like) to whatever you like, using the LWP::UserAgent agent method:

もし 'User-Agent' 行だけを変更するなら、LWP::UserAgent の agent メソッドを 使って、$browser オブジェクトのデフォルト行である "libwww-perl/5.65" (あるいは似たようなもの) から好みのものに変更できます:

   $browser->agent('Mozilla/4.76 [en] (Win98; U)');


A default LWP::UserAgent object acts like a browser with its cookies support turned off. There are various ways of turning it on, by setting its cookie_jar attribute. A "cookie jar" is an object representing a little database of all the HTTP cookies that a browser can know about. It can correspond to a file on disk (the way Netscape uses its cookies.txt file), or it can be just an in-memory object that starts out empty, and whose collection of cookies will disappear once the program is finished running.

デフォルトの LWP::UserAgent オブジェクトは、クッキー対応をオフにした ブラウザのように振る舞います。 cookie_jar 属性を設定することで有効にするいくつかの方法があります。 「クッキー容器」("cookie jar") は、ブラウザが知っている全ての HTTP クッキーのデータベースを表現するオブジェクトです。 これはディスク上のファイル (Netscape が cookies.txt ファイルで 使っている方法)か、単に空から開始してプログラム終了時に消えてしまう メモリ上のオブジェクトに対応させることができます。

To give a browser an in-memory empty cookie jar, you set its cookie_jar attribute like so:

メモリ上に空のクッキー容器をブラウザに設定するには、以下のように cookie_jar 属性に設定します:


To give it a copy that will be read from a file on disk, and will be saved to it when the program is finished running, set the cookie_jar attribute like this:

ディスク上のファイルから読み込んだデータを指定して、プログラム終了時に 保存するためには、cookie_jar 属性を以下のように設定します:

  use HTTP::Cookies;
  $browser->cookie_jar( HTTP::Cookies->new(
    'file' => '/some/where/cookies.lwp',
        # where to read/write cookies
    'autosave' => 1,
        # save it to disk when done

That file will be an LWP-specific format. If you want to be access the cookies in your Netscape cookies file, you can use the HTTP::Cookies::Netscape class:

このファイルは LWP 固有の形式です。 Netscape のクッキーファイルのクッキーをアクセスするようにするには、 HTTP::Cookies::Netscape クラスを使えます:

  use HTTP::Cookies;
    # yes, loads HTTP::Cookies::Netscape too
  $browser->cookie_jar( HTTP::Cookies::Netscape->new(
    'file' => 'c:/Program Files/Netscape/Users/DIR-NAME-HERE/cookies.txt',
        # where to read cookies

You could add an 'autosave' => 1 line as further above, but at time of writing, it's uncertain whether Netscape might discard some of the cookies you could be writing back to disk.

上述のように 'autosave' => 1 行を追加することもできますが、 書き込み時に Netscape がディスクに書き戻そうとしたクッキーの一部を 破棄するかどうかは不確定です。


Many HTML forms send data to their server using an HTTP POST request, which you can send with this syntax:

多くの HTML フォームは HTTP POST リクエストを使ってサーバにデータを 送りますが、これには以下のような文法を使います:

 $response = $browser->post( $url,
     formkey1 => value1, 
     formkey2 => value2, 

Or if you need to send HTTP headers:

あるいは HTTP ヘッダを送る必要がある場合は:

 $response = $browser->post( $url,
     formkey1 => value1, 
     formkey2 => value2, 
   headerkey1 => value1, 
   headerkey2 => value2, 

For example, the following program makes a search request to AltaVista (by sending some form data via an HTTP POST request), and extracts from the HTML the report of the number of matches:

例えば、以下のプログラムは AltaVista に (フォームデータを HTTP POST リクエスト経由で送信することで) 検索リクエストを送って、HTML から マッチングの数の報告を展開します:

  use strict;
  use warnings;
  use LWP 5.64;
  my $browser = LWP::UserAgent->new;
  my $word = 'tarragon';
  my $url = '';
  my $response = $browser->post( $url,
    [ 'q' => $word,  # the Altavista query string
      'pg' => 'q', 'avkw' => 'tgz', 'kl' => 'XX',
  die "$url error: ", $response->status_line
   unless $response->is_success;
  die "Weird content type at $url -- ", $response->content_type
   unless $response->content_type eq 'text/html';

  if( $response->decoded_content =~ m{AltaVista found ([0-9,]+) results} ) {
    # The substring will be like "AltaVista found 2,345 results"
    print "$word: $1\n";
  else {
    print "Couldn't find the match-string in the response\n";

GET フォームデータを送信する

Some HTML forms convey their form data not by sending the data in an HTTP POST request, but by making a normal GET request with the data stuck on the end of the URL. For example, if you went to and ran a search on "Blade Runner", the URL you'd see in your browser window would be:

HTML フォームには、フォームデータを送るのに HTTP POST リクエストで 送るのではなく、URL の末尾にデータを付けて 通常の GET リクエストで 送るものもあります。 例えば、 で "Blade Runner" を検索すると、ブラウザウィンドウに 表示される URL は:

To run the same search with LWP, you'd use this idiom, which involves the URI class:

同じ検索を LWP で実行するには、URI を使ったこの定型文を使います:

  use URI;
  my $url = URI->new( '' );
    # makes an object representing the URL
  $url->query_form(  # And here the form data pairs:
    'title'    => 'Blade Runner',
    'restrict' => 'Movies and TV',
  my $response = $browser->get($url);

See chapter 5 of Perl & LWP for a longer discussion of HTML forms and of form data, and chapters 6 through 9 for a longer discussion of extracting data from HTML.

HTML フォームとフォームデータに関するより長い議論についてはPerl & LWP の 第 5 章を、HTML からのデータの抽出に関するより長い議論については 第 6 章から第 9 章を参照してください。

URL の絶対化

The URI class that we just mentioned above provides all sorts of methods for accessing and modifying parts of URLs (such as asking sort of URL it is with $url->scheme, and asking what host it refers to with $url->host, and so on, as described in the docs for the URI class. However, the methods of most immediate interest are the query_form method seen above, and now the new_abs method for taking a probably-relative URL string (like "../foo.html") and getting back an absolute URL (like ""), as shown here:

先に触れた URI クラスは、URL の一部にアクセスしたり修正したりする あらゆる種類のメソッドを提供しています ($url->scheme で URL の種類を調べたり、$url->host で 参照しているホストを調べたり、などです; これらは URI クラスの文書 に 記述されています)。 しかし、もっとも直接重要なメソッドは上述の query_form と、 以下のように ("../foo.html" のような) おそらく相対の URL を取って ("" のような)絶対 URL を返す new_abs メソッドです:

  use URI;
  $abs = URI->new_abs($maybe_relative, $base);

For example, consider this program that matches URLs in the HTML list of new modules in CPAN:

例えば、CPAN の新しいモジュールの HTML リストにある URL にマッチングする このプログラムを考えます:

  use strict;
  use warnings;
  use LWP;
  my $browser = LWP::UserAgent->new;
  my $url = '';
  my $response = $browser->get($url);
  die "Can't get $url -- ", $response->status_line
   unless $response->is_success;
  my $html = $response->decoded_content;
  while( $html =~ m/<A HREF=\"(.*?)\"/g ) {
    print "$1\n";

When run, it emits output that starts out something like this:



However, if you actually want to have those be absolute URLs, you can use the URI module's new_abs method, by changing the while loop to this:

しかし、実際には絶対 URL がほしい場合、URI モジュールの new_abs メソッドを使って、while ループをこのように変更できます:

  while( $html =~ m/<A HREF=\"(.*?)\"/g ) {
    print URI->new_abs( $1, $response->base ) ,"\n";

(The $response->base method from HTTP::Message is for returning what URL should be used for resolving relative URLs -- it's usually just the same as the URL that you requested.)

(HTTP::Message$response->base メソッドは、 相対 URL を解決するためにどの URL が使われるかを返されます -- これは普通 要求した URL と同じです。)

That program then emits nicely absolute URLs:

このプログラムはいい感じに絶対 URL を出力します:

See chapter 4 of Perl & LWP for a longer discussion of URI objects.

URI オブジェクトに関するより長い説明については Perl & LWP の第 4 章を 参照してください。

Of course, using a regexp to match hrefs is a bit simplistic, and for more robust programs, you'll probably want to use an HTML-parsing module like HTML::LinkExtor or HTML::TokeParser or even maybe HTML::TreeBuilder.

もちろん、href のマッチングに正規表現を使うのは少し単純化しすぎです; より堅牢なプログラムのためには、HTML::LinkExtor, HTML::TokeParser, HTML::TreeBuilder のような HTML パースモジュールを使いたいでしょう。


LWP::UserAgent objects have many attributes for controlling how they work. Here are a few notable ones:

LWP::UserAgent オブジェクトには、動作を制御するための多くの属性があります。 注目するべきものをいくつか示します:

  • $browser->timeout(15);


    This sets this browser object to give up on requests that don't answer within 15 seconds.

    これは、リクエストに 15 秒以内に返事がないと諦めるように ブラウザオブジェクトを設定します。

  • $browser->protocols_allowed( [ 'http', 'gopher'] );

    $browser->protocols_allowed( [ 'http', 'gopher'] );

    This sets this browser object to not speak any protocols other than HTTP and gopher. If it tries accessing any other kind of URL (like an "ftp:" or "mailto:" or "news:" URL), then it won't actually try connecting, but instead will immediately return an error code 500, with a message like "Access to 'ftp' URIs has been disabled".

    これは、HTTP と gopher 以外のプロトコルを話さないようにオブジェクトに 設定します。 ("ftp:" や "mailto:" や "news:" URL のような)その他の種類の URL で アクセスしようとすると、実際に接続しようとはせず、直ちにエラーコード 500 と "Access to 'ftp' URIs has been disabled" のようなメッセージで返ります。

  • use LWP::ConnCache; $browser->conn_cache(LWP::ConnCache->new());

    use LWP::ConnCache; $browser->conn_cache(LWP::ConnCache->new());

    This tells the browser object to try using the HTTP/1.1 "Keep-Alive" feature, which speeds up requests by reusing the same socket connection for multiple requests to the same server.

    これは、同じサーバへの複数のリクエストに対して同じソケット接続を 再利用することでリクエストを高速化する、HTTP/1.1 "Keep-Alive" 機能を 使うようにブラウザオブジェクトに設定します。

  • $browser->agent( 'SomeName/1.23 (more info here maybe)' )

    $browser->agent( 'SomeName/1.23 (more info here maybe)' )

    This changes how the browser object will identify itself in the default "User-Agent" line is its HTTP requests. By default, it'll send "libwww-perl/versionnumber", like "libwww-perl/5.65". You can change that to something more descriptive like this:

    これはブラウザオブジェクトが HTTP リクエストのデフォルトの "User-Agent" 行で何と名乗るかを変更します。 デフォルトでは、"libwww-perl/5.65" のように、 "libwww-perl/バージョン番号" を送ります。 以下のようなもっと説明的なものに変更できます:

      $browser->agent( 'SomeName/3.14 (' );

    Or if need be, you can go in disguise, like this:


      $browser->agent( 'Mozilla/4.0 (compatible; MSIE 5.12; Mac_PowerPC)' );
  • push @{ $ua->requests_redirectable }, 'POST';

    push @{ $ua->requests_redirectable }, 'POST';

    This tells this browser to obey redirection responses to POST requests (like most modern interactive browsers), even though the HTTP RFC says that should not normally be done.

    これは、このブラウザは POST リクエストに対するリダイレクト要求を (最近のほとんどの対話的ブラウザと同様) 拒否することを示します (ただし HTTP の RFC は普通は拒否するべきではないとしています);

For more options and information, see the full documentation for LWP::UserAgent.

さらなるオプションと情報については、LWP::UserAgent の完全な 文書 を参照してください。


If you want to make sure that your LWP-based program respects robots.txt files and doesn't make too many requests too fast, you can use the LWP::RobotUA class instead of the LWP::UserAgent class.

あなたの LWP ベースのプログラムが robots.txt を尊重して、一度に多くの リクエストを送らないようにするには、LWP::UserAgent クラスの代わりに LWP::RobotUA クラスが使えます。

LWP::RobotUA class is just like LWP::UserAgent, and you can use it like so:

LWP::RobotUA クラスは LWP::UserAgentのようなもので、以下のようにして 使えます:

  use LWP::RobotUA;
  my $browser = LWP::RobotUA->new('YourSuperBot/1.34', '');
    # Your bot's name and your email address

  my $response = $browser->get($url);

But HTTP::RobotUA adds these features:

しかし、HTTP::RobotUA には以下のような機能が追加されています:

  • If the robots.txt on $url's server forbids you from accessing $url, then the $browser object (assuming it's of class LWP::RobotUA) won't actually request it, but instead will give you back (in $response) a 403 error with a message "Forbidden by robots.txt". That is, if you have this line:

    $url のサーバの robots.txt$url へのアクセスを禁止しているなら、 $browser オブジェクト (LWP::RobotUA クラスと仮定しています) は実際に リクエストを送ることはせず、代わりに ($response で) "Forbidden by robots.txt" というメッセージ付きで 403 エラーを返します。 つまり、以下のようにすると:

      die "$url -- ", $response->status_line, "\nAborted"
       unless $response->is_success;

    then the program would die with an error message like this:

    このプログラムは以下のようなエラーメッセージを出力して die します: -- 403 Forbidden by robots.txt
      Aborted at line 1234
  • If this $browser object sees that the last time it talked to $url's server was too recently, then it will pause (via sleep) to avoid making too many requests too often. How long it will pause for, is by default one minute -- but you can control it with the $browser->delay( minutes ) attribute.

    この $browser オブジェクトが、最後に $url のサーバと通信したのが 最近過ぎる場合、あまり頻繁にリクエストを送りすぎないように、(sleep を 使って) 一時停止します。 一時停止する時間は、デフォルトでは 1 分です -- しかし $browser->delay( minutes ) 属性で制御できます。

    For example, this code:


      $browser->delay( 7/60 );

    ...means that this browser will pause when it needs to avoid talking to any given server more than once every 7 seconds.

    このブラウザは、どのサーバに対しても 7 秒に 1 回以上接続しないように するために一時停止することを意味します。

For more options and information, see the full documentation for LWP::RobotUA.

さらなるオプションと情報については、LWP::RobotUA の完全な 文書 を参照してください。


In some cases, you will want to (or will have to) use proxies for accessing certain sites and/or using certain protocols. This is most commonly the case when your LWP program is running (or could be running) on a machine that is behind a firewall.

場合によっては、ある種のサイトへのアクセスやある種のプロトコルの使用のために プロキシを使用したい(あるいは使用する必要がある)ことがあります。 これは、LWP を使ったプログラムがファイアウォールの背後のマシンで実行される (あるいは実行されるかもしれない)時にもっとも一般的な状況です。

To make a browser object use proxies that are defined in the usual environment variables (HTTP_PROXY, etc.), just call the env_proxy on a user-agent object before you go making any requests on it. Specifically:

ブラウザオブジェクトが通常の環境変数(HTTP_PROXY など)で定義している プロキシを使うようにするには、単にリクエストの前にユーザーエージェント オブジェクトの env_proxy を呼び出すだけです。 具体的には:

  use LWP::UserAgent;
  my $browser = LWP::UserAgent->new;
  # And before you go making any requests:

For more information on proxy parameters, see the LWP::UserAgent documentation, specifically the proxy, env_proxy, and no_proxy methods.

プロキシ引数に関するさらなる情報については、LWP::UserAgent の 文書 の、特に proxy, env_proxy, no_proxy メソッドを参照してください。


Many web sites restrict access to documents by using "HTTP Authentication". This isn't just any form of "enter your password" restriction, but is a specific mechanism where the HTTP server sends the browser an HTTP code that says "That document is part of a protected 'realm', and you can access it only if you re-request it and add some special authorization headers to your request".

多くのウェブサイトは文書へのアクセスを "HTTP 認証" を使って制限しています。 これは単なる "パスワードを入力してください" 形式の制限ではなく、 HTTP サーバがブラウザに「この文書は保護された「レルム」の一部であり、 リクエストに専用の認証ヘッダを追加して再リクエストした場合にのみ アクセスできます」という意味の HTTP コードを返すという、専用の機構です。

For example, the admins stop email-harvesting bots from harvesting the contents of their mailing list archives, by protecting them with HTTP Authentication, and then publicly stating the username and password (at -- namely username "unicode-ml" and password "unicode".

例えば、 の管理者は、メーリングリストアーカイブを HTTP 認証で 保護して、このユーザー名とパスワードを ( で)公にする (ユーザー名 "unicode-ml" パスワード "unicode") ことで、 電子メールアドレス収集ボットがアーカイブからアドレスを収集するのを 阻止しています。

For example, consider this URL, which is part of the protected area of the web site:

例えば、ウェブサイトのうち保護されたエリアである、この URL について 考えます:

If you access that with a browser, you'll get a prompt like "Enter username and password for 'Unicode-MailList-Archives' at server ''".

ここにブラウザでアクセスすると、 "Enter username and password for 'Unicode-MailList-Archives' at server ''" のようなプロンプトが出ます。

In LWP, if you just request that URL, like this:

LWP では、もし単にこの URL にリクエストしたいなら、以下のようにします:

  use LWP;
  my $browser = LWP::UserAgent->new;

  my $url =
  my $response = $browser->get($url);

  die "Error: ", $response->header('WWW-Authenticate') || 'Error accessing',
    #  ('WWW-Authenticate' is the realm-name)
    "\n ", $response->status_line, "\n at $url\n Aborting"
   unless $response->is_success;

Then you'll get this error:


  Error: Basic realm="Unicode-MailList-Archives"
   401 Authorization Required
   Aborting at line 9.  [or wherever]

...because the $browser doesn't know any the username and password for that realm ("Unicode-MailList-Archives") at that host (""). The simplest way to let the browser know about this is to use the credentials method to let it know about a username and password that it can try using for that realm at that host. The syntax is:

なぜなら $browser はこのホスト ("") のこのレルム ("Unicode-MailList-Archives") のユーザー名とパスワードを知らないからです。 ブラウザにこれを知らせるもっとも簡単な方法は、このホストのこのレルムに使う ユーザーとパスワードを知らせる credentials メソッドを使うことです。 文法は:

   'username' => 'password'

In most cases, the port number is 80, the default TCP/IP port for HTTP; and you usually call the credentials method before you make any requests. For example:

ほとんどの場合、ポート番号は HTTP のデフォルト TCP/IP ポートである 80 です; そして普通はリクエストの前に credentials メソッドを呼び出します。 例えば:

    'plinky' => 'banjo123'

So if we add the following to the program above, right after the $browser = LWP::UserAgent->new; line...

そして、上述のプログラムに以下のものを加えるなら、$browser = LWP::UserAgent->new; 行の直後にします…

  $browser->credentials(  # add this to our $browser 's "key ring"
    'unicode-ml' => 'unicode'

...then when we run it, the request succeeds, instead of causing the die to be called.

それから実行すると、リクエストは die を引き起こさずに成功します。

HTTPS URL にアクセスする

When you access an HTTPS URL, it'll work for you just like an HTTP URL would -- if your LWP installation has HTTPS support (via an appropriate Secure Sockets Layer library). For example:

HTTPS の URL にアクセスすると、(LWP インストール時に (適切な SSL ライブラリを使って) HTTPS 対応しているなら) HTTP の URL と同様に動作します。 例えば:

  use LWP;
  my $url = '';   # Yes, HTTPS!
  my $browser = LWP::UserAgent->new;
  my $response = $browser->get($url);
  die "Error at $url\n ", $response->status_line, "\n Aborting"
   unless $response->is_success;
  print "Whee, it worked!  I got that ",
   $response->content_type, " document!\n";

If your LWP installation doesn't have HTTPS support set up, then the response will be unsuccessful, and you'll get this error message:

HTTPS 対応なしで LWP がインストールされている場合、レスポンスは失敗し、 以下のようなエラーメッセージが発生します:

  Error at
   501 Protocol scheme 'https' is not supported
   Aborting at line 7.   [or whatever program and line]

If your LWP installation does have HTTPS support installed, then the response should be successful, and you should be able to consult $response just like with any normal HTTP response.

LWP インストール時に HTTPS 対応されて いる 場合、レスポンスは成功し、 通常の HTTP レスポンスと同様の $response が使えます。

For information about installing HTTPS support for your LWP installation, see the helpful README.SSL file that comes in the libwww-perl distribution.

LWP インストール時に HTTPS 対応にするための情報については、libwww-perl 配布に 同梱されている README.SSL ファイルを参照してください。


When you're requesting a large (or at least potentially large) document, a problem with the normal way of using the request methods (like $response = $browser->get($url)) is that the response object in memory will have to hold the whole document -- in memory. If the response is a thirty megabyte file, this is likely to be quite an imposition on this process's memory usage.

大きな (または少なくとも大きい可能性がある) 文書をリクエストするとき、 ($response = $browser->get($url) のような) リクエストメソッドを使った 通常の方法の問題点は、メモリ上のレスポンスオブジェクトが文書全体を保持する 必要があることです -- メモリ上の。 もしレスポンスが 30 メガバイトのファイルなら、おそらくプロセスのメモリ消費に とって負担となるでしょう。

A notable alternative is to have LWP save the content to a file on disk, instead of saving it up in memory. This is the syntax to use:

注目するべき代替案は、LWP がメモリ上ではなく、ディスク上のファイルに内容を 保存するようにすることです。 これが使用するための文法です:

  $response = $ua->get($url,
                         ':content_file' => $filespec,

For example,


  $response = $ua->get('',
                         ':content_file' => '/tmp/sco.html'

When you use this :content_file option, the $response will have all the normal header lines, but $response->content will be empty.

:content_file オプションを使うとき、$response には通常のヘッダ行 全てが含まれていますが、$response->content は空です。

Note that this ":content_file" option isn't supported under older versions of LWP, so you should consider adding use LWP 5.66; to check the LWP version, if you think your program might run on systems with older versions.

この ":content_file" オプションは古いバージョンの LWP では 対応していないので、もし古いバージョンのシステムでも実行されるかもしれないと 考えるなら、LWP バージョンをチェックするために use LWP 5.66; を 追加することを考慮するべきかもしれません。

If you need to be compatible with older LWP versions, then use this syntax, which does the same thing:

もし古い LWP バージョンとの互換性が必要なら、同じことをする以下の構文を 使ってください:

  use HTTP::Request::Common;
  $response = $ua->request( GET($url), $filespec );


Remember, this article is just the most rudimentary introduction to LWP -- to learn more about LWP and LWP-related tasks, you really must read from the following:

この記事は LWP の最も初歩的な説明に過ぎないことに注意してください -- LWP および LWP 関連のタスクについてもっと学ぶためには、本当に以下のものを 読まなければなりません:

  • LWP::Simple -- simple functions for getting/heading/mirroring URLs

    LWP::Simple -- URL の取得、ヘッダ取得、ミラーのための単純な関数

  • LWP -- overview of the libwww-perl modules

    LWP -- libwww-perl モジュールの概説

  • LWP::UserAgent -- the class for objects that represent "virtual browsers"

    LWP::UserAgent -- 「仮想ブラウザ」を表現するオブジェクトのクラス

  • HTTP::Response -- the class for objects that represent the response to a LWP response, as in $response = $browser->get(...)

    HTTP::Response -- $response = $browser->get(...) などで LWP レスポンスを表現するためのオブジェクトのクラス

  • HTTP::Message and HTTP::Headers -- classes that provide more methods to HTTP::Response.

    HTTP::MessageHTTP::Headers -- HTTP::Response にもっと多くの メソッドを提供するクラス

  • URI -- class for objects that represent absolute or relative URLs

    URI -- 絶対および相対の URL を表現するオブジェクトのクラス

  • URI::Escape -- functions for URL-escaping and URL-unescaping strings (like turning "this & that" to and from "this%20%26%20that").

    URI::Escape -- ("this & that" と "this%20%26%20that" の変換のように) URL エスケープと URL アンエスケープのための関数

  • HTML::Entities -- functions for HTML-escaping and HTML-unescaping strings (like turning "C. & E. Brontë" to and from "C. &amp; E. Bront&euml;")

    HTML::Entities -- ("C. & E. Brontë" と "C. &amp; E. Bront&euml;" の 変換のように) HTML エスケープと HTML アンエスケープのための関数

  • HTML::TokeParser and HTML::TreeBuilder -- classes for parsing HTML

    HTML::TokeParserHTML::TreeBuilder -- HTML をパースするためのクラス

  • HTML::LinkExtor -- class for finding links in HTML documents

    HTML::LinkExtor -- HTML 文書中のリンクを探すクラス

  • The book Perl & LWP by Sean M. Burke. O'Reilly & Associates, 2002. ISBN: 0-596-00178-9.

    Sean M. Burke による書籍 Perl & LWP O'Reilly & Associates, 2002. ISBN: 0-596-00178-9.


Copyright 2002, Sean M. Burke. You can redistribute this document and/or modify it, but only under the same terms as Perl itself.


Sean M. Burke