PHPでのストリーム処理の実装

PHPエクステンションの作り方 第6回

　本連載では、PHPエクステンションの作成方法を紹介します。前回は、ネイティブライブラリを組み込みPHPエクステンションから利用する方法を紹介しました。今回もそのネイティブライブラリを利用し、さらにそこで取得できるリソースをfreadやfopen関数で利用できるようにストリームとして提供する方法を紹介します。

対象読者

　PHPでの基本構文を理解している方で、PHPエクステンションに興味がある方、さらに深くPHPを知りたい方で、C言語の基本的な構文を理解している方を対象としています。

必要な環境

　この記事では、PHP 5.4を使用し、Linux環境で確認を行っています。インストール方法は初回を参照してください。

　また、前回使用したlibzipも必要ですので、そちらも前回を参照してインストールしてください。

PHPストリームとは

　PHPではデータの読み書きをする際に、通常のファイルの読み書きをする関数を使ってアクセスできる機能があり、このようなリソースの提供方法をストリームと呼びます。例えば、HTTP上のコンテンツを以下のようにアクセスできることは多くの方が知っているのではないかと思います。

HTTP上のリソースをストリームとして取得する方法

$fp = fopen("http://www.coltware.com/","r");

　同様に、今回のサンプルコードの元になっているZipでも以下のようにアクセスできます。

Zipファイルのエントリファイルをストリームとして取得する方法

$fp = fopen("zip:///home/webadmin/sample/file1.zip#file1.txt","r");

　このように取得するリソースの種類を問わず同じ方法でリソース上のコンテンツデータを取得できる方法が提供されています。上記以外にも、PHPではサポートされているプロトコルがPHPのマニュアルに記述がありますので、参考にしてください。

　また、このストリームは関数やクラスのメソッドから返すこともできますので、関数の戻り値をストリームにすれば、より自由な形で取得しやすくすることも可能です。

メソッドからのPHPストリームの作成

　最初は、PZipFileクラス上のメソッドからZipファイルの中の一つのデータをストリームとして取得する方法を紹介します。

　前回までのサンプルではZipファイル内のエントリ情報にアクセスする実装をしておりましたので、そこで取得した情報を元にそのままデータにアクセスできるようになるというメリットがあります。実際に、サンプルコードのPZipFile::getStream()でストリームを戻すように実装します。

PHPストリームを作成する手順

　PHPストリームを作成するには、以下の手順で作成します。

1. ストリームの状態を管理する構造体を用意する
2. ストリームの読み込み（read）、書き込み（write）、クローズ（close）などを行うための関数を作成する
3. 2で作成した関数をハンドラとして登録する構造体を用意する
4. 3で作成した構造体を用いてファイルをオープンする関数を作成する

ストリームの状態を管理する構造体を作成する

　ストリームとしてデータを読みこんだ際にどのリソース（1）から、どの程度のバイト数（2）を読みこんだかを管理するための構造体を用意します。最低限、これらの情報があれば読込のみであれば十分です。また、この構造体は自由に定義できます。

pzip_stream.cの抜粋

struct php_pzip_stream_data_t {
    struct zip_file *zf;  // ……（1）
    size_t cursor;        // ……（2）
};