名前¶

CGI::WebGzip - 文字出力をGZipにより圧縮するPerl拡張

概要¶

  # Usual code working with STDOUT:
  use CGI::WebGzip;
  print "Content-type: text/html\n\n";
  print "Hello, world!";

  # 標準出力に使用される標準的なコードです:
  use CGI::WebGzip;
  print "Content-type: text/html\n\n";
  print "Hello, world!";

  # Lesser compression (by default 9, now - 5)
  use CGI::WebGzip(5);

  # より小さい圧縮 (by default 9, now - 5)
  use CGI::WebGzip(5);

  # Set callback function which would be called after compressing,
  # but before any output. You may set cookie in this function to
  # display them later on the page (using JavaScript).
  use CGI::WebGzip;
  BEGIN {
      CGI::WebGzip::setCallback(sub {
          my ($nL, $oL) = (length $_[0], length $_[2]);
          print sprintf "Set-Cookie: page_size=%d,%d; path=/\n", $oL, $nL;
          return 1;
      });
  }

  # どんな出力の前にでも,圧縮された後に呼ばれるcallback関数設定して下さい.
  # あなたはこの関数の中でCookieをセットすことができる
  # 後でJavaScriptを使用してCookieを表示して下さい.
  use CGI::WebGzip;
  BEGIN {
      CGI::WebGzip::setCallback(sub {
          my ($nL, $oL) = (length $_[0], length $_[2]);
          print sprintf "Set-Cookie: page_size=%d,%d; path=/\n", $oL, $nL;
          return 1;
      });
  }

  # Working together with CGI::WebOut.
  use CGI::WebGzip;
  use CGI::WebOut;
  print "Hello, world!";

  # CGI::WebOutと一緒に動かす場合.
  use CGI::WebGzip;
  use CGI::WebOut;
  print "Hello, world!";

  # Work in FastCGI environment.
  require CGI::WebGzip;
  while (read request) {
     CGI::WebGzip::import;  # captures output
     ...
     CGI::WebGzip::flush(); # releases output
  }

  # FastCGI環境で動かす場合.
  require CGI::WebGzip;
  while (read request) {
     CGI::WebGzip::import;  # captures output
     ...
     CGI::WebGzip::flush(); # releases output
  }

OVERVIEW¶

PHPではあなたはこのように書くことができます:ob_start("ob_gzhandler") そして GZipにより圧縮された出力を自動ですべて取得することができます. CGI::WebGzipは同じことをします. あなたのプログラムの開始時にこのモジュールを取り込むことにより, その間の全ての出力を得ることができます. スクリプトが終了するとCGI::WebGzipは取得したデータを圧縮しそれをブラウザに送ります.

もしブラウザがGZipエンコーディングを実装していない場合,出力を得ず, データを圧縮しないでしょう.

説明¶

use CGI::WebGzip([compression_level])

Captures all the script output for deflating. Default compression level is 9 (maximum). Value 0 means no compression.

取得した全てのスクリプトの出力を縮小させます. デフォルトの圧縮レベルは9です（最大値）. 圧縮レベル0は圧縮しないことを意味します.

void flush()

Flushes the compressed buffer immediately and releases STDOUT capture. Usable in FastCGI environment together with manual import() call (see synopsis above).

圧縮されたバッファを標準出力に即座に流します. FastCGIが用いられている環境では手動でimport()呼び出しとともに行います(上に書かれたSYNOPSISを見るように).

bool getAbility()

Returns undef if browser we are in CGI mode, browser supports compression and Compress::Zlib is found. Otherwise returns non-empty diagnostic message.

CGIモードでブラウザが圧縮をサポートしかつCompress::Zlibが存在する場合undefを返す. そうでなければ空でない診断メッセージを返します

bool isCompressibleType($type)

Returns true if page of this MIME type can be compressed.

このMIMEタイプを圧縮することができるのならばtrueを返す.

CODE setCallback(CODE $func)

Sets the callback function called AFTER compression process, but BEFORE any output. You may print additional headers in this function (for example, set cookies). If this function returns false, compressed data would not be printed later (presume function does it itself). Arguments:

どんな出力の前にも,圧縮処理の後に呼ばれるcallback関数設定して下さい. この関数で追加ヘッダをつけることができる(例えば,cookiesをセットする).

  bool callback(string $compressedBody, string $headers, string $originalBody)

Returns previous callback reference.

前のcallbackの参照を返します.

int setLevel($level)

Sets another compression level. Returns previous.

別の圧縮レベルをセットします. 前の圧縮レベルを返します.

string getStatus()

You may determine if the compression was performed by this function. It returns undef if data has been compressed or non-empty diagnostic message otherwise.

この関数により圧縮が実行されたかを確認することができる. データが圧縮されたかまたは空でない診断メッセージがなければundefを返す.

($compressedBody, $modifiedHeaders, $status) ob_gzhandler(string $body [,string $headers])

Returns compressed data (additionally analysing headers, if present). In scalar context returns $compressedBody only. Input headers can be modified, thus this function returns $modifiedHeaders. In $status compression feruse message is returned (or undef if everything is OK). This function can be used exactly as PHPs ob_gzhandler().

圧縮されたデータを返す(その上で現在のヘッダを分析する) スカラーコンテキストは$compressedBodyだけを返す 入力ヘッダーを変更することができます,したがってこの関数は$modifiedHeadersを返します。 $statusは圧縮したメッセージを返す(undefもしくは全てOK). この関数はまさにPHPのob_gzhandler()として使用することができます.

string deflate_gzip($text, $level);

Compresses the input string and returns result.

入力文字列を圧縮して結果を返します.

EXPORT¶

デフォルトでは何もない.

DEPENDENCIES¶

CGI::WebGzipはCompress::Zlibだけに依存しています. もしこのライブラリが見つからない場合でもエラーメッセージは生成されません.

作者¶

Dmitry Koterov <koterov at cpan dot org>

SEE ALSO¶

Compress::Zlib, CGI::WebOut

翻訳者¶

 atsushi kobayashi([email protected])