索引トップ用語の索引ランキング

Hyperwave 関数

導入

Hyperwave™ は、Graz の » IICM において開発されました。当初は Hyper-G という名前でしたが、 (1996年に)商品化された際に Hyperwave に変更されました。
Hyperwave はフリーソフトウエアではありません。最新版は5.5で、» http://www.hyperwave.com/ から得ることができます。30 日間試用可能な版を注文することができます。
Hyperwave API モジュールも参照ください。
Hyperwave は、データベースに似た情報システム (HIS, Hyperwave Information Server)です。このシステムは、文書の保存と管理に着目しています。文書には、あらゆるデータとすることが可能で、同時にファイルに保存することもできます。各文書には、オブジェクトレコードが付属しています。オブジェクトレコードは、その文書のメタデータを有しています。メタデータは、ユーザーにより拡張可能な属性のリストです。ある種の属性は、Hyperwave サーバーにより常に設定されますが、その他は、ユーザーにより修正可能です。属性は、名前=値という形式の名前/値の組です。完全なオブジェクトレコードは、ユーザーの指定した数のこの組を有することができます。属性の名前は、ユニークである必要はありません。例えば、title はオブジェクトレコードの中に複数回現れる可能性があります。これは、複数の言語で title を指定したい場合に意味があります。このような場合、各 title の値は、2文字の言語の短縮型の後にコロンが続くものを前に置くという慣習があります。例えば、'en:Title in English'または 'ge:Titel in deutsch'。 description または keywords のような他の属性は、潜在的な候補です。残りの属性の値とコロンで区切ることにより他の文字列で言語の短縮形を置換することも可能です。
各オブジェクトレコードは、各名前/キーの組で表した文字列であり、改行で区切られています。Hyperwave拡張には、属性名をキーとした連想配列としての第二の表現も有しています。多言語属性値は、それ自体で言語の短縮形をキーとする別の連想配列を構成します。実際、複数の属性は、属性値をキーとし、左にコロンがある文字列で連想配列を構成します。(これは完全に実装されていません。まだ、適正に処理されるのは、属性 Title, Description, Keyword のみです。)
文書と共に文書中の全てのハイパーリンクは、同じくオブジェクトレコードとして保存されます。文書がデータベースに挿入される際には、文書中のハイパーリンクは文書から取り除かれ独立したオブジェクトとして保存されます。リンクに関するオブジェクトレコードは、リンクに関する記述を開始した場所と終了した場所に関する情報を有しています。オリジナルの文書を得るためには、リンクの無いプレーンな文書とリンクのリストを取り出し、リンクを再び挿入する必要があります。 (関数 hw_pipedocument() および hw_gettext() がこれを行います。) リンクを文書から分離する利点は明白です。リンクをされている文書が名前を変更した場合でも、そのリンクは簡単に適宜変更可能です。そのリンクを有する文書は、全く影響を受けません。文書自体を変更せずに文書にリンクを追加することさえ可能です。
hw_pipedocument() および hw_gettext() が自動的にリンクの挿入を行うというのは、耳で聞く程簡単なことではありません。リンクの挿入は、ある種のドキュメント階層の操作を含んでいます。Web サーバーではこの機能はファイルシステムにより提供されますが、Hyperwave は固有の階層を有しており、名前はその階層のオブジェクトの位置を反映しません。このため、リンク作成時はまず Hyperwave の階層および名前空間から各Web名前空間の階層への対応付けを必要とします。HyperwaveとWebの間の根本的な違いは、Hyperwaveでは名前と階層の間を明確に区別することです。名前は、階層におけるオブジェクトの位置に関する情報を全く有していません。Webでは、名前もオブジェクトの階層における位置に関する情報を有しています。このため、対応付けには2種類の手法があります。つまり、Hyperwaveの階層およびHyperwaveオブジェクトの名前がURLに反映されたものまたは名前のみのどちらかです。簡単のため、第2の方法が使用されます。my_objectという名前のHyperwaveオブジェクトは、Hyperwave階層のどこに位置するかによらず http://host/my_objectに対応付けます。 Hyperwave階層においては、名前parent/my_object を有するオブジェクトは、Hyperwave階層の my_objectの子となります。しかし、Web の名前空間では正反対となるため、ユーザーに混乱を生じる可能性があります。これは、適当なオブジェクト名を選択することによってのみ防止することができます。
この選択により第2の問題が生じます。PHPをどうやって起動しますか? URL http://host/my_objectは、例えば、Webサーバーに対してこのURLを http://host/php_script/my_objectに書き換えさせない限り、いかなる PHPスクリプトもコールしません。スクリプトphp_scriptは $PATH_INFO変数を評価し、Hyperwaveサーバーから名前my_objectを有するオブジェクトを取得します。一つだけ欠点がありますが、簡単に修正可能です。URLの書き換えは、そのWebサーバー上の他のドキュメントにアクセスする時には許可されません。Hyperwaveサーバーで検索を行うPHPスクリプトは実現不可能です。このため、例えばhttp://host/Hyperwaveで始まるようなURLを除くような少なくとも第2の書き換え規則を必要とします。
上記の機構的なリンクは、他のドキュメントに挿入されます。
PHPがサーバーモジュールでもCGIスクリプトでもなく、例えばCD-ROM上にHyperwaveサーバーの内容をダンプするといったスタンドアロンのアプリケーションとして実行されている場合はより複雑になります。このような場合、Hyperwave 階層を保ち、ファイルシステムに対応付けを行う必要があります。これは、(例えば、'/' を含む名前を選択することにより)固有の階層に対応付けている場合には、オブジェクト名と衝突する可能性があります。このため、'/' は他の文字、例えば '_' に置換されるべきです。
Hyperwaveサーバーと通信するためのネットワークプロトコルは、» HG-CSP(Hyper-G Client/Serverプロトコル)という名前です。このプロトコルは、例えばオブジェクトレコードを得るといったある動作を始めるためのメッセージに基づいています。 Hyperwaveサーバーの初期の版では、二つの専用クライアント (Harmony,Amadeus) がサーバーとの通信用に提供されていました。これらは、Hyperwaveが商品化された際になくなりました。代わりに、 wavemasterが提供されました。wavemasterは、HTTPからHG-CSPへのプロトコルコンバーターのようなものです。これは、データベースの管理とドキュメントの可視化を全てWebインターフェースにより行うという考えによるものです。wavemasterは、インターフェースをカスタマイズするための作業用に一連のプレースホルダーを導入しています。この一連のプレースホルダーは、 PLACE言語と呼ばれています。 PLACEは、通常のプログラミング言語の機能の多くを欠いており、言語への拡張としては、プレースホルダーのリストを拡大するだけです。このことは、JavaScript を使用することにより作業が楽になったわけではないということと類似しています。
Hyperwave サポートを PHP に付加することにより、インターフェースのカスタマイズ用のプログラミング言語を有していないという穴を埋めることになります。この機能は、HG-CSP により定義された全てのメッセージをサポートするだけでなく、完全なドキュメントの取得といった更に強力なコマンドも提供します。
Hyperwave は、情報の特定の部分を名付けるために固有の用語法を用います。この方法は、広範に用いられ、拡張されています。ほとんどすべの関数は、次のデータ型のどれかを操作します。

object ID: Hyperwave サーバーの各オブジェクトについてユニークな整数値。オブジェクトレコード (ObjectID) の属性の一つでもあります。 object id は、オブジェクトを指定するための入力パラメータとしてしばしば用いられます。
object record: attribute=value 形式の属性-値の組となる文字列。この組は、復改文字で他と区切られています。オブジェクトレコードは、hw_object2array() によりオブジェクトレコードに簡単に変換できます。いくつかの関数は、オブジェクトレコードを返します。これらの関数の名前は、obj で終わります。
object array: オブジェクトの全ての属性を有する連想配列。キーは属性名です。ある属性が、オブジェクトレコードに複数回現れる場合、別の添字または連想配列が生成されます。(title,keyword,description のような) 言語に依存する属性は、省略語をキーとした連想配列として作成されます。他の複数の属性は、添字配列として作成されます。 PHP 関数は、オブジェクト配列を返しません。
hw_document: これは、完全に新規のデータ型であり、 HTML,PDF 等といった実際のドキュメントを保持します。これは、幾分 HTML 用に最適化されていますが、他のフォーマットに使用することが可能です。

オブジェクトレコードの配列を返すいくつかの関数は、そのレコードに関する統計情報を有する連想配列も返します。この配列は、オブジェクトレコード配列の最後の要素です。統計配列には、次のエントリがあります。

Hidden: 属性 PresentationHints が Hidden であるオブジェクトレコードの数
CollectionHead: 属性 PresentationHints が CollectionHead であるオブジェクトレコードの数
FullCollectionHead: 属性 PresentationHints が FullCollectionHead であるオブジェクトレコードの数
CollectionHeadNr: 属性 PresentationHints が CollectionHead であるオブジェクトレコードの配列のインデックス
FullCollectionHeadNr: 属性 PresentationHints が FullCollectionHead であるオブジェクトレコードの配列のインデックス
Total: Total: オブジェクトレコードの数

要件

この拡張モジュールは、Hyperwaveサーバを必要とします。このサーバは、» http://www.hyperwave.com/でダウンロード可能です。

インストール手順

この » PECL 拡張モジュールは PHP にバンドルされていません。
これらの関数を使用するには、オプション --with-hyperwave[=DIR] を使用して Hyperwave サポートつきで PHP をコンパイルする必要があります。
Windows ユーザがこれらの関数を使用するには、php.ini の中で php_hyperwave.dll を有効にします。この PECL 拡張モジュールの DLL を » PHP ダウンロードページまたは » http://snaps.php.net/ からダウンロードできます。

Apache との組み合わせ

Hyperwave モジュールは、PHP が Apache モジュールとしてコンパイルされた場合に、最適化されています。この場合、Apache が書き換えエンジンを使用する場合、内部の Hyperwave サーバーをほぼ完全にユーザーから隠すことが可能です。以下の手順によりこのことを説明します。
Hyperwaveサポートを有効にしてApacheに組み込んだPHPは、wavemaster に基づく本来のHyperwaveの手法を置換するものなので、Apacheサーバーは、Hyperwave Webインターフェースとしてのみ処理を行うと仮定します。これは必然ではありませんが、設定が容易になります。考え方は非常に簡単です。まず最初に$_ENV['PATH_INFO']変数を評価し、Hyperwaveオブジェクトの名前としてその値を処理するPHPスクリプトが必要です。このスクリプトを'Hyperwave'と呼びましょう。URL http://your.hostname/Hyperwave/name_of_object 'name_of_object'という名前のHyperwaveオブジェクトを返します。オブジェクトの型に応じて、スクリプトは対応した処理を行う必要があります。collectionの場合、恐らく子のリストを返すことになります。ドキュメントの場合、MIME型と内容を返すことになります。Apacheの書換エンジンを使用した場合、若干の改善が見込まれます。ユーザーの立場で見ると、URL http://your.hostname/name_of_object がオブジェクトを返せば、より簡単になります。書き換えの規則は非常に簡単です。


RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L]

この状態で、全てのURLはHyperwaveサーバーのオブジェクトに関係付けられています。これにより問題の解決が容易になります。'Hyperwave' スクリプト以外の検索といった他のスクリプトを実行することはできません。これは次のような別の規則により修正することができます。


RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L]

これにより、ディレクトリ/usr/local/apache/htdocs/hwが追加のスクリプトや他のファイル用に確保されます。この規則は、一つ前の規則よりも前に評価されることに注意してください。これには若干の欠点があります。つまり、'hw/'で始まる名前を有する Hyperwave オブジェクトは全て隠されてしまいます。このため、このような名前を使用しないようにしてください。例えば画像用により多くのディレクトリが必要な場合、更に規則を加えるか一つのディレクトリに全てを置くかしてください。最後にRewriteEngineをオンにすることを忘れないでください。


RewriteEngine on

経験上、次のようなスクリプトが必要になることと思われます。

オブジェクト自身を返す
検索を許可する
自分を定義する
プロファイルを設定する
オブジェクト属性を表示したり、ユーザーに関する情報を表示したり、サーバーのステータスを表示したり等する追加される関数毎に一つ

Rewrite Engineの一つの代わりとして、Apache ErrorDocumentディレクティブを使用することもできます。しかし、ErrorDocument でリダイレクトされたページは、POSTデータを受け取ることはできないことに注意して下さい。

実行時設定

php.ini の設定により動作が変化します。
表 116. Hyperwave 設定オプション

名前	デフォルト	変更の可否	変更履歴
hyperwave.allow_persistent	"0"	PHP_INI_SYSTEM	PHP 4.3.2 以降で使用可能です。
hyperwave.default_port	"418"	PHP_INI_ALL

PHP_INI_* 定数の詳細および定義については付録 G. php.ini ディレクティブ を参照してください。

リソース型

リソース型は定義されていません。

定義済み定数

以下の定数が定義されています。この関数の拡張モジュールが PHP 組み込みでコンパイルされているか、実行時に動的にロードされている場合のみ使用可能です。

HW_ATTR_LANG (integer)
HW_ATTR_NR (integer)
HW_ATTR_NONE (integer)

Todo

まだやるべきことがいくつかあります。

hw_InsertDocument は、 hw_insertobject()と hw_putdocument()に分割する必要があります。
いくつかの関数の名前はまだ修正されていません。
多くの関数は最初のパラメータとして現在の接続 ID を必要とします。これにより入力が多くかつ頻繁になってますが、一つだけの接続をオープンしている場合には必要ないはずです。デフォルト接続の導入により改善される見込みです。
多重属性を処理するには、オブジェクトレコードからオブジェクト配列への変換機能が必要です。