フィルタリングサポート関数

サポート関数は、リソース上で情報を操作または生成するため、フィルタリング中に使用されます。ロボットは、フィルタリング関数を呼び出すことによって、リソースを処理することができます。これらの関数は、ファイル filter.conf の列挙および生成のフィルタで使用することができます。

assign-source

assign-source 関数は、指定した情報ソースに新規の値を割り当てます。この関数により、フィルタリング処理中の編集が可能になります。この関数は、明示的な新規値を割り当てるか、または、別の情報ソースから値をコピーすることができます。

プロパティー

dst

値を変更するソースの名前。

value

明示的な値を指定。

src

dst にコピーする情報ソース。

value プロパティーまたは src プロパティーのどちらかを指定する必要がありますが、両 方は指定しません。

例

Data fn=assign-source dst=type src=content-type

assign-type-by-extension

assign-type-by-extension 関数は、リソースのファイル名を使用してタイプを決定し、処理を継続するリソースにこのタイプを割り当てます。

assign-type-by-extension を使用可能にするには、セットアップ中にsetup-type-by-extension 関数を呼び出す必要があります。

プロパティー

src

比較するファイル名のソース。ソースを指定しない場合、デフォルトではリソースのパスになります。

例

MetaData fn=assign-type-by-extension

clear-source

clear-source 関数は、指定されたデータソースを削除します。通常は、この関数を実行する必要はありません。assign-source 関数を使用することにより、ソースを作成または置換することができます。

プロパティー

src

削除するソースの名前。

例

次の例は、パスのソースを削除します。

MetaData fn=clear-source src=path

convert-to-html

convert-to-html 関数は、リソースのタイプが指定の MIME タイプと一致する場合、現在のリソースを HTML ファイルに変換して処理を継続します。変換フィルタは、変換中のファイルのタイプを自動的に検出します。

プロパティー

type

変換を行う MIME タイプ。

例

次の関数呼び出しのシーケンスにより、フィルタは、すべての Adobe Acrobat PDF ファイル、Microsoft RTF ファイル、および FrameMaker MIF ファイル、およびファイルを配信するサーバーによってタイプが指定されていないファイルを HTML に変換します。

Data fn=convert-to-html type=application/pdf

Data fn=convert-to-html type=application/rtf

Data fn=convert-to-html type=application/x-mif

Data fn=convert-to-html type=unknown

copy-attribute

copy-attribute 関数は、リソース記述の 1 つのフィールドからの値を別のフィールドにコピーします。

プロパティー

src

コピー元のリソース記述のフィールド。

dst

ソースのコピー先のリソース記述の項目。

truncate

コピーするソースの最大長。

clean

省略されたテキストを修正するかどうか、分割された単語を修正するかを示す論理値プロパティー。デフォルトでは、このプロパティーは false に設定されています。

例

Generate fn=copy-attribute \\

src=partial-text dst=description truncate=200 clean=true

generate-by-exact

generate-by-exact 関数は、既存のソースが別の値と完全に一致する場合にかぎり、指定された値を持つソースを生成します。

プロパティー

dst

生成するソースの名前。

value

dst に割り当てる値。

src

比較対象のソース。

例

次の例は、ホストが www.siroe.com の場合に、分類を siroe に設定します。

Generate fn="generate-by-exact" match="www.siroe.com:80" src="host" value="Siroe" dst="classification"

generate-by-prefix

この generate-by-prefix 関数は、既存のソースのプレフィックスが別の値と一致する場合に、指定された値を持つソースを生成します。

プロパティー

dst

生成するソースの名前。

value

dst に割り当てる値。

src

比較対象のソース。

match

src と比較する値。

例

次の例は、プロトコルプレフィックスが HTTP の場合、分類を World Wide Web に設定します。

Generate fn="generate-by-prefix" match="http" src="protocol" value="World Wide Web" dst="classification"

generate-by-regex

generate-by-regex 関数は、既存のソースが正規表現に一致する場合に、指定した値を持つソースを生成します。

プロパティー

dst

生成するソースの名前。

value

dst に割り当てる値。

src

比較対象のソース。

match

src と比較する正規表現の文字列。

例

次の例は、ホスト名が正規表現 *.siroe.com に一致する場合に、分類を siroe に設定します。たとえば、developer.siroe.com および home.siroe.com の両方にあるリソースは、Siroe として分類されます。

Generate fn="generate-by-regex" match="\\\\*.siroe.com" src="host" value="Siroe" dst="classification"

generate-md5

generate-md5 関数は、MD5 チェックサムを生成し、リソースに追加します。これにより、filter-by-md5 関数を使用して、重複する MD5 チェックサムを持つリソースを拒否することができます。

プロパティー

なし

例

Data fn=generate-md5

generate-rd-expires

generate-rd-expires 関数は、有効期限を生成して、指定されたソースに追加します。この関数は、HTTP ヘッダーおよび HTML <META> タグなどのメタデータを使用し、リソースから任意の有効期限を取得します。有効期限が存在しない場合は、現在の日付から 3 ヶ月間の有効期限を生成します。

プロパティー

dst

ソースの名前。指定を省略した場合、ソースのデフォルトは rd-expires となります。

例

Generate fn=generate-rd-expires

generate-rd-last-modified

generate-rd-last-modified 関数は、現在の時間を指定されたソースに追加します。

プロパティー

dst

ソースの名前。指定を省略した場合、ソースのデフォルトは rd-last-modified となります。

例

Generate fn=generate-last-modified

rename-attribute

rename-attribute 関数は、リソース記述のフィールドの名前を変更します。この関数は、たとえば、extract-html-meta で <META> タグからフィールドに情報をコピーし、そのフィールドの名前を変更する場合にとても便利です。

プロパティー

src

1 つの名前から別の名前へのマッピングを含む文字列。

例

次の例は、属性の名前を author から author-name に変更します。

Generate fn=rename-attribute src="author->author-name"