名前¶

LWP::Simple - simple procedural interface to LWP

LWP::Simple - LWP への簡単な手続き的インターフェース

概要¶

 perl -MLWP::Simple -e 'getprint "http://www.sn.no"'

 use LWP::Simple;
 $content = get("http://www.sn.no/");
 die "Couldn't get it!" unless defined $content;

 if (mirror("http://www.sn.no/", "foo") == RC_NOT_MODIFIED) {
     ...
 }

 if (is_success(getprint("http://www.sn.no/"))) {
     ...
 }

説明¶

This module is meant for people who want a simplified view of the libwww-perl library. It should also be suitable for one-liners. If you need more control or access to the header fields in the requests sent and responses received, then you should use the full object-oriented interface provided by the LWP::UserAgent module.

このモジュールは、libwww-perl ライブラリの簡略化されたビューが欲しい人々に向いています。これはワンライナーにも適しています。もしより多くの制御や送信するリクエストや受信したレスポンスのヘッダにアクセスする必要があれば、LWP::UserAgent モジュールによって提供されるフルにオブジェクト指向なインターフェースを使わなければなりません。

The following functions are provided (and exported) by this module:

このモジュールにより以下の関数が提供 (そしてエクスポート) されます:

get($url)

The get() function will fetch the document identified by the given URL and return it. It returns undef if it fails. The $url argument can be either a simple string or a reference to a URI object.

get() 関数は与えられた URL により示されるドキュメントを取り出し、それを返します。失敗すれば undef を返します。引数 $url は単純な文字列にも URI オブジェクトへのリファレンスにもすることができます。

You will not be able to examine the response code or response headers (like 'Content-Type') when you are accessing the web using this function. If you need that information you should use the full OO interface (see LWP::UserAgent).

この関数を使って Web にアクセスすると、応答コードや ('Content-Type' のような) レスポンスヘッダを検査することは出来ません。もしその情報が必要であれば、フル OO インターフェースを使わなければなりません (LWP::UserAgentをご覧下さい)。

head($url)

Get document headers. Returns the following 5 values if successful: ($content_type, $document_length, $modified_time, $expires, $server)

ドキュメントヘッダを取得します。正常ならば以下の 5 つの変数を返します: ($content_type, $document_length, $modified_time, $expires, $server)

Returns an empty list if it fails. In scalar context returns TRUE if successful.

失敗すると空リストを返します。スカラコンテキストでは成功すると真を返します。

getprint($url)

Get and print a document identified by a URL. The document is printed to the selected default filehandle for output (normally STDOUT) as data is received from the network. If the request fails, then the status code and message are printed on STDERR. The return value is the HTTP response code.

URL により識別されるドキュメントを取得し出力します。ネットワークからデータが受信されると、ドキュメントは選択されたデフォルトの出力ファイルハンドル(通常は STDOUT) に出力されます。もしリクエストが失敗すると、ステータス・コードとメッセージが STDERR に出力されます。戻り値は HTTP 応答コードです。

getstore($url, $file)

Gets a document identified by a URL and stores it in the file. The return value is the HTTP response code.

URL により識別されるドキュメントを取得し、ファイルに格納します。戻り値は HTTP 応答コードです。

mirror($url, $file)

Get and store a document identified by a URL, using If-modified-since, and checking the Content-Length. Returns the HTTP response code.

If-modified-since を使い、Content-Length を使いながら、URL により識別されるドキュメントを取得し、ファイルに格納します。戻り値は HTTP 応答コードです。

This module also exports the HTTP::Status constants and procedures. You can use them when you check the response code from getprint(), getstore() or mirror(). The constants are:

このモジュールは HTTP::Status 定数とプロシージャもエクスポートします。 getprint(), getstore(), mirror() からの応答コードをチェックするときに使うことが出来ます。定数には以下のものがあります:

   RC_CONTINUE
   RC_SWITCHING_PROTOCOLS
   RC_OK
   RC_CREATED
   RC_ACCEPTED
   RC_NON_AUTHORITATIVE_INFORMATION
   RC_NO_CONTENT
   RC_RESET_CONTENT
   RC_PARTIAL_CONTENT
   RC_MULTIPLE_CHOICES
   RC_MOVED_PERMANENTLY
   RC_MOVED_TEMPORARILY
   RC_SEE_OTHER
   RC_NOT_MODIFIED
   RC_USE_PROXY
   RC_BAD_REQUEST
   RC_UNAUTHORIZED
   RC_PAYMENT_REQUIRED
   RC_FORBIDDEN
   RC_NOT_FOUND
   RC_METHOD_NOT_ALLOWED
   RC_NOT_ACCEPTABLE
   RC_PROXY_AUTHENTICATION_REQUIRED
   RC_REQUEST_TIMEOUT
   RC_CONFLICT
   RC_GONE
   RC_LENGTH_REQUIRED
   RC_PRECONDITION_FAILED
   RC_REQUEST_ENTITY_TOO_LARGE
   RC_REQUEST_URI_TOO_LARGE
   RC_UNSUPPORTED_MEDIA_TYPE
   RC_INTERNAL_SERVER_ERROR
   RC_NOT_IMPLEMENTED
   RC_BAD_GATEWAY
   RC_SERVICE_UNAVAILABLE
   RC_GATEWAY_TIMEOUT
   RC_HTTP_VERSION_NOT_SUPPORTED

The HTTP::Status classification functions are:

HTTP::Status 分類関数には以下のものがあります:

is_success($rc): True if response code indicated a successful request.

応答コードが成功であることを示せばであれば真。
is_error($rc): True if response code indicated that an error occurred.

応答コードがエラーが発生したことを示せば真。

The module will also export the LWP::UserAgent object as $ua if you ask for it explicitly.

明示的に指定すれば、このモジュールは LWP::UserAgent オブジェクトも $ua としてエクスポートします。

The user agent created by this module will identify itself as "LWP::Simple/#.##" (where "#.##" is the libwww-perl version number) and will initialize its proxy defaults from the environment (by calling $ua->env_proxy).

このモジュールによって作成されるユーザ・エージェントは、 "LWP::Simple/#.##" ("#.##" は libwww-perl のバージョン番号) で識別され、 ($ua->env_proxy を呼ぶことにより) 環境変数によってプロキシーが初期化されます。

CAVEAT¶

Note that if you are using both LWP::Simple and the very popular CGI.pm module, you may be importing a head function from each module, producing a warning like "Prototype mismatch: sub main::head ($) vs none". Get around this problem by just not importing LWP::Simple's head function, like so:

LWP::Simple と、とても有名な CGI.pm の両方のモジュールを使っている場合、両方のモジュールから head 関数をインポートしようとして、 "Prototype mismatch: sub main::head ($) vs none" のような警告が出るかもしれないことに注意してください。この問題を回避するには、単に以下のようにして、LWP::Simple の head 関数をインポートして:

        use LWP::Simple qw(!head);
        use CGI qw(:standard);  # then only CGI.pm defines a head()

Then if you do need LWP::Simple's head function, you can just call it as LWP::Simple::head($url).

もし LWP::Simple's head 関数が必要なら、LWP::Simple::head($url) のようにして呼び出すことです。

名前¶

概要¶

説明¶

CAVEAT¶

SEE ALSO¶