SSI (Server Side Includes) の書き方

AddOutputFilter ディレクティブ

AddOutputFilter ディレクティブを使用する場合、どの拡張子に対して SSI ディレクティブの解析するかを指定します。下記の例では、拡張子 .shtml に対して SSI ディレクティブの解析するよう Apache に伝えています。

# AddOutputFilter ディレクティブで SSI を有効にする例
AddType text/html .shtml
AddOutputFilter INCLUDES .shtml

ただし、上記の例では既存のページに SSI ディレクティブを追加したい場合、拡張子を変更しなければならない欠点があります。その場合、そのページの拡張子と、そのページへのすべてのリンクを変更しなければなりません。もしも拡張子に .html を指定した場合は、それらの問題は回避できますが、後述するパフォーマンスの問題が発生します。

AddOutputFilter ディレクティブの詳細は、.htaccessの書き方を参照して下さい。

XBitHack ディレクティブ

XBitHack ディレクティブを使用する場合、ファイルの実行ビットが立っている場合に SSI ディレクティブを解析することを Apache に伝えます。実行ビットとは、ファイルのパーミッションにおける実行フラグ ("x" で表される) のことを指します。そのため、XBitHack ディレクティブを利用する方法では、既存のページに SSI ディレクティブを追加したい場合、拡張子の変更が不要になります。ファイルの実行ビットを立てるには FTPソフトウェアや、コンソール上から chmod コマンドを使用してファイルを実行可能に変更します。

さくらインターネットのレンタルサーバでテストした結果、"500 internal server error" が発生し、エラーログには "XBitHack not allowed here" と記録されているため、AllowOverride ディレクティブで許可されていないようです。そのため、拡張子を .shtml に変更して SSI を利用する必要があります。拡張子が .html でも SSI を利用できることは確認していますが、後述するパフォーマンスの問題を確認して下さい。

# XBitHack ディレクティブで SSI を有効にする例
XBitHack on

# 実行ビット (x) が付与されていない
% ls -l sample.shtml
-rw-r-xr--  1 murashun  users  85 Aug 31 10:39 sample.shtml

# chmod コマンドで実行ビットを立てる例
% chmod +x sample.shtml

# 実行ビット (x) が付与された
% ls -l sample.shtml
-rwxr-xr-x  1 murashun  users  85 Aug 31 10:39 sample.shtml

上記の例では、サーバに SSH でログインし、コンソール上からパーミッションを変更している例となります。chmod コマンドにより、実行ビット ("x") を追加しています。実行ビットを追加後に ls -l コマンドで対象ファイルのパーミッションを確認すると、実行ビットが付与されていることが確認できます。

XBitHack ディレクティブの詳細は、.htaccessの書き方を参照して下さい。

config - echomsg

echo 要素が未定義の変数をエコーしようとした際に、表示されるメッセージを定義します。下記の例では、echomsg に "変数は宣言されていません" という文字列を設定して、定義済みの変数 (msg) と未定義の変数 (hoge) を echo した結果を表示しています。

<!--#config echomsg="変数は宣言されていません" -->
<!--#set var="msg" value="Hello, world!" -->

<!--#echo var="hoge" --><br>
<!--#echo var="msg" -->

変数は宣言されていません
Hello, world!

config - errmsg

ドキュメントの解析中にエラーが発生した場合、表示されるメッセージを定義します。下記の例では、echomsg に "エラーが発生しました" という文字列を設定して、SSI ディレクティブには存在しない #hoge を実行した結果を表示しています。

<!--#config errmsg="エラーが発生しました" -->
<!--#hoge var="msg" value="Hello, world!" -->

エラーが発生しました

config - sizefmt

fsize 要素で表示されるファイルサイズのフォーマットを指定します。"bytes" を属性値に指定するとバイト単位で表示されます。(単位は表示されず整数表示となります。) "abbrev" を属性値に指定すると単位が "K" (KByte) や "M" (MByte) で表示されます。下記の例では、"sample1.html" のファイルサイズが 314 Byte、 "sample2.html" のファイルサイズが 2.1 MByte の html ファイルを用意して表示しています。

<!--#config sizefmt="bytes" -->
<!--#fsize file="sample1.html" --><br>
<!--#fsize file="sample2.html" --><br>
<br>
<!--#config sizefmt="abbrev" -->
<!--#fsize file="sample1.html" --><br>
<!--#fsize file="sample2.html" --><br>

314
2,186,087

314 
2.1M

上記の例では、abbrev を指定しても sample1.html は小数点表示にはならず、sample2.html は切り下げて表示されています。また、存在しないファイルを指定した場合、"[an error occurred while processing this directive]" と表示されます。

config - timefmt

時刻を表示する際のフォーマットを定義します。%Y や %M などの strftime 関数の変換指定子が使用できます。使用できる変換指定子は以下の通りです。

<!--#config timefmt="%Y/%m/%d" -->
<!--#echo var="DATE_LOCAL" --><br>
<!--#flastmod  file="example.shtml" -->

2015/09/14
2015/09/14

上記の例では、年・月・日を / を区切ったフォーマットを表示しています。"DATE_LOCAL" は現在日時を表し、"flastmod" は "example.shtml" の最終更新時刻を表します。

echo - var

指定した変数、または環境変数を表示します。未定義の場合は、(none) と表示されます。また、サーバによっては HTTP 環境変数の一部も使用可能です。さくらインターネットのレンタルサーバでは HTTP 環境変数の一部が使用可能です。使用可能な環境変数は以下の通りです。

<!--#echo var="DOCUMENT_NAME" --><br>

<!--#set var="msg" value="Hello, world!" -->
<!--#echo var="msg" --><br>

<!--#echo var="hoge" -->

example.shtml
Hello, world!
(none)

echo - encoding

変数を出力する前に、変数の中に含まれる特殊文字をどのようにエンコードするかを指定します。"none" はエンコードを行いません。"url" はパーセントエンコードを行います。"entity" は HTMLエンコードを行います。Apache のデフォルトのエンコーディングは ISO-8859-1 (Latin-1) であるため、変数の中に日本語が含まれる場合、文字化けを起こします。 文字化けを回避するには、"none" を設定して下さい。また、クロスサイトスクリプティングの脆弱性を回避するために、ユーザからのデータを受け取る場合は常にエンコードを行って下さい。エンコーディングの設定を省略した場合は、"entity" がデフォルトで設定されます。

<!--#set var="msg" value="日本語が含まれる文字列です。" -->
<!--#echo var="msg" --><br>
<!--#echo var="msg" encoding="none" --><br>
<!--#echo encoding="none" var="msg" --><br>

(文字化けのため省略)
(文字化けのため省略)
日本語が含まれる文字列です。

上記のように、日本語が含まれる変数を echo した場合は文字化けを起こします。また、encoding="none" は var の前に設定しなければ効果がありません。ファイルを保存する場合の文字コードと、ブラウザの表示エンコードが一致しているかも確認して下さい。

exec - cgi

指定した CGI スクリプトを実行し、その結果を表示します。さくらインターネットのレンタルサーバで CGI スクリプトを実行する場合は、同じディレクトリにファイルを配置する必要があります。

<!--#exec cgi="example.cgi" -->

さくらインターネットの場合は、/cgi-bin ディレクトリ配下でしか CGI スクリプトが動作しないため、shtml も /cgi-bin ディレクトリ配下に配置する必要があります。もしも .pl ファイルを実行する場合は、cmd 属性を使用して下さい。

exec - cmd

指定したコマンドを実行し、その結果を表示します。設定された文字列は /bin/sh で実行されます。引数 (arg1, arg2 ...) を指定する場合は、スペースで区切って指定して下さい。Perl 側で引数を受け取るには @ARGV を参照して下さい。

<!-- 引数なしの場合 -->
<!--#exec cmd="/bin/ls" -->

<!-- 引数ありの場合 -->
<!--#exec cmd="/bin/ls arg1 arg2" -->

<!-- .pl を実行する場合 -->
<!--#exec cmd="example.pl" -->

ただし、サーバによってはコマンド名に絶対パスを指定できない、パス名で上位ディレクトリ (..) を参照できない、コマンドの引数を渡せない、コマンド実行時のカレントディレクトリが異なるなどの違いがあります。さくらインターネットの場合は、cmd の実行が許可されていないため、上記のコマンドは使えません。ただし、同ディレクトリにある .pl などのスクリプトファイルの実行は可能です。

fsize - file

指定したファイルのサイズを表示します。ファイルサイズのフォーマットは、config 要素の sizefmt 属性で変更可能です。ドキュメントが存在するディレクトリからの相対パスでファイル名を指定します。ただし、../ を含むパス や 絶対パスは使用できません。上位ディレクトリのファイルを指定する場合は、virtual を使用します。設定例については、config - sizefmt を参照して下さい。

fsize - virtual

指定したファイルのサイズを表示します。ファイルサイズのフォーマットは、config 要素の sizefmt 属性で変更可能です。ホスト名からの相対パスでファイル名を指定します。パスが / から始まらない場合は、ドキュメントが存在するディレクトリからの相対パスとして扱われます。設定例については、config - sizefmt を参照して下さい。

flastmod - file

指定したファイルの最終更新時刻を表示します。日付のフォーマットは config 要素の timefmt 属性で変更可能です。ドキュメントが存在するディレクトリからの相対パスでファイル名を指定します。ただし、../ を含むパス や 絶対パスは使用できません。上位ディレクトリのファイルを指定する場合は、virtual を使用します。日時のフォーマット指定については、config - timefmt を参照して下さい。

<!--#config timefmt="%Y/%m/%d" -->
<!--#flastmod  file="example.shtml" -->

2015/09/14

flastmod - virtual

指定したファイルの最終更新時刻を表示します。日付のフォーマットは config 要素の timefmt 属性で変更可能です。ホスト名からの相対パスでファイル名を指定します。パスが / から始まらない場合は、ドキュメントが存在するディレクトリからの相対パスとして扱われます。日時のフォーマット指定については、config - timefmt を参照して下さい。

<!--#config timefmt="%Y/%m/%d" -->
<!--#flastmod  file="./example.shtml" -->

2015/09/14

include - file

指定したファイルの中身を読込んで表示します。ドキュメントが存在するディレクトリからの相対パスでファイル名を指定します。ただし、../ を含むパス や 絶対パスは使用できません。上位ディレクトリのファイルを指定する場合は、virtual を使用します。

<!--#include file="example.html" -->

ただし、自分自身のファイルを読み込むと無限ループになるため、[an error occurred while processing this directive] が表示されます。また、存在しないファイルを読み込んだ場合も同様のエラーメッセージが表示されます。

include - virtual

指定したファイルの中身を読込んで表示します。ホスト名からの相対パスでファイル名を指定します。パスが / から始まらない場合は、ドキュメントが存在するディレクトリからの相対パスとして扱われます。

ただし、自分自身のファイルを読み込むと無限ループになるため、[an error occurred while processing this directive] が表示されます。また、存在しないファイルを読み込んだ場合も同様のエラーメッセージが表示されます。

printenv

使用可能な環境変数の一覧を表示します。

<!--#printenv -->

SCRIPT_URL=/example.shtml
SCRIPT_URI=https://murashun.jp/example.shtml
HTTP_CONNECTION=Keep-Alive
･･･(中略)･･･
DOCUMENT_NAME=example.shtml

長いので中略していますが、表示される環境変数としては DATE_GMT, DATE_LOCAL, DOCUMENT_NAME, DOCUMENT_ROOT, DOCUMENT_URI, GATEWAY_INTERFACE, HTTP_ACCEPT, HTTP_ACCEPT_LANGUAGE, HTTP_CONNECTION, HTTP_HOST, HTTP_UPGRADE_INSECURE_REQUESTS, HTTP_USER_AGENT, HTTP_VIA, HTTP_X_SAKURA_FORWARDED_FOR, LAST_MODIFIED, PATH, QUERY_STRING, REMOTE_ADDR, REMOTE_HOST, REMOTE_PORT, REQUEST_METHOD, REQUEST_URI, SCRIPT_FILENAME, SCRIPT_NAME, SCRIPT_URI, SCRIPT_URL, SERVER_ADDR, SERVER_ADMIN, SERVER_NAME, SERVER_PORT, SERVER_PROTOCOL, SERVER_SIGNATURE, SERVER_SOFTWARE, USER_NAME などがあります。

set - var

変数の名前を設定できます。変数に値を入れるには、value 属性を使います。

<!--#set var="hoge" value="123" -->

set - value

変数に代入する値を設定できます。変数名の宣言は var 属性を使います。

<!--#set var="hoge" value="123" -->