config 要素

• sizefmt-value = 'bytes' / 'abbrev'
• strftime-format = <strftime(3) date/time format string>

errmsg 属性は、 SSI 処理が失敗した時に出力されるメッセージを 指定します。

sizefmt 属性は大きさの書式を指定します。値 bytes でバイト数 (12,345 と読点が入れられる [NCSA]) を、 値 abbrev でキロバイトやメガバイトに適当に短縮した値を返すようになります。

timefmt 属性の値は日付を値に持つ変数や flastmod 要素の値に影響します。

これらの属性は、どれか一つを必ず指定しなければなりません。 複数指定している SSI な文書や説明は見たことがありません。 ただし MUST NOT なのか SHOULD NOT なのかはわかりませんねぇ。

echo 要素

変数 var の値を出力します。値が空であれば (none) を返します。

Apache 1.3.12 以降では encoding 属性が実装されています。 既定値は "entity" です。 (他の実装では既定値 "none" に相当します。)

Encoding "uri" は、安全でない文字を URI符号化します。 Encoding "entity" は、安全でない文字を HTML の実体参照形式にします。この時 ISO-8859-1 が想定されますから、他の charset の値だと正しく処理されません。

encoding 属性は対応する var 属性より前になければなりません。 encoding 属性の値は同じ要素内で次の encoding 属性が 指定されるまで有効です。

exec 要素

cgi 属性と cmd 属性のどちらか一方を指定しなければなりません。

Apache の実装では Options +IncludesNOEXEC になっていれば SSI は有効でも exec 要素は無効になります。

例:

• <!--#exec cmd="ls" -->
• <!--#exec cmd="cmd" -->
• <!--#exec cgi="/cgi-bin/example.cgi" -->

flastmod 要素

ファイルの最終更新日時を取得します。 file 属性のとり得る値 は環境により異なります。

返す値の形式は config 要素の timefmt 属性によります。

fsize 要素

ファイルの大きさを取得します。 返す値の形式は config 要素の sizefmt 属性によります。

include 要素

file 属性で指定したファイルまたは virtual 属性で指定した URI の資源を挿入します。 file 属性と virtual 属性はどちらか一方が (でもって一方だけ) 必ず指定されていなければなりません。

Apache の実装では、 file 属性の値は「現在階層からの相対経路」 ("/" (根) で始まったり、 "../" (上の階層) を含んだりしない経路) でなければなりません。また、通常の接続制御の対象となります。 (取り込み対象が deny from all みたいになってると、上手くいかない。)

include 要素で挿入する資源でも SSI が有効である場合、 それを処理してから挿入されます。その場合変数はもともとの(挿入元の) 値が引き継がれるようです。

Apache では file 属性より virtual 属性を推奨してます。

printenv 要素

属性はありません。

Apache 1.2 以降で実装されています。全ての変数と値の一覧を出力します。 Apache 1.3.12 では適切に実体参照を使用します。 (See echo 要素) 例:

• <!--#printenv -->

set 要素

echo 要素とは逆に、変数の値を設定します。 value 属性の値には変数置換を使えます。

Apache 1.2 以降で実装されています。

例:

• <!--#set var="modified" value="$LAST_MODIFIED" -->
• <!--#set var="cost" value="\$100" -->
• <!--#set var="date" value="${DATE_LOCAL}_${DATE_GMT}" -->

フロー制御 (if, elif, else, endif) 要素

条件分岐します。各要素で囲まれた区間のうち、条件に合致する 区間だけが出力されます。 Apache 1.2 以降で実装されています。

if, elif 要素の属性:

• test-condition = string [*WSP operator *WSP string2] / "(" *WSP test-condition *WSP ")" / "!" *WSP test-condition / test-condition *WSP "&&" *WSP test-condition / test-condition *WSP "||" *WSP test-condition
• operator = "=" / "!=" / "<" / "<=" / ">" / ">="
• string2 = string / regexp
• regexp = <egrep(1) regexp>
• string = token / squoted-string
• squoted-string = "'" vtext "'"
• token = vtext-w *(WSP vtext-w)
• vtext-w = <vtext except WSP>

演算子とかの優先順位は、 "=" = "!=" < "&&" = "||" < "!" です。

例:

        <!--#if expr="${Windows} && ${InternetExplorer}" -->
        イかれた実装を揶揄する表現をここに
        <!--#else -->
        いけてる Strict な文書構造とスタイルをここに
        <!--#endif -->

DATE_GMT

現在時刻 (GMT) が値に入ります。値の形式は、 config 要素により 設定可能です。 [NCSA] [APACHE]

DATE_LOCAL

現在時刻 (地方時) が値に入ります。値の形式は、 config 要素により 設定可能です。 [NCSA] [APACHE] 例:

        <!--#config timefmt="%A %B %d, %Y" -->
        Today is <!--#echo var="DATE_LOCAL" -->

DOCUMENT_NAME

利用者が要求したファイル名(ディレクトリ名を除く) [NCSA] [APACHE]。

DOCUMENT_PATH_INFO

渡す実装があるらしい。

DOCUMENT_URI

利用者が要求した URI 経路(path) [NCSA] [APACHE]。

include 要素で入り組んでいる場合、これは現在の文書の URI ではありません。

LAST_MODIFIED

現在処理中の資源の最終更新日時が値に入ります。値の形式は config 要素の timefmt 属性の値に拠ります。 [NCSA] [APACHE]

QUERY_STRING_UNESCAPED

変数 QUERY_STRING を URI unescape して shell escape したものです [NCSA]。 NCSA HTTPd にはありますが、 Apache の文書にはありません。 (少なくても昔の Apache には実装されていたようです。)

変数置換 variable substition

config, exec, flastmod, fsize, include, set 各要素で使えるそうです。 (どの属性でも使えるんだろうか? 謎)

• vtext = *(vchar / variable-ref)
• vchar = 1*( <OCTET except "$"> / quoted-pair )
• quoted-pair = "\" OCTET
• variable-ref = "$" variable-name / "${" variable-name "}"

"$" から始まる文字列は変数名とみなされ、その変数の値に置き換えられます。 "$" を表すには "\$" と quote します。

quoted-pair の quote される文字に何が使えるのかは不明です。 少なくても "$" は使えます。 "\" もおそらく使えるでしょう。 <"> の例も出てきます。なんでもいいんかな?