SSI使用详解

综述

　　SSI是英文Server Side Includes的缩写，翻译成中文就是服务器端包含的意思。从技术角度上说，SSI就是在HTML文件中，可以通过注释行调用的命令或指针。SSI具有强大的功能，只要使用一条简单的SSI 命令就可以实现整个网站的内容更新，时间和日期的动态显示，以及执行shell和CGI脚本程序等复杂的功能。SSI 可以称得上是那些资金短缺、时间紧张、工作量大的网站开发人员的最佳帮手。本文将主要结合Apache服务器介绍SSI的使用方法。

　　如何启动SSI？

　　在Apache服务器下，可以通过直接编辑服务器配置文件或者在需要使用SSI的目录中创建.htaccess文件来启动SSI。具体过程如下：

　　1.服务器配置文件

　　如果用户具有对服务器配置文件的访问权限，可以通过编辑文件access.conf和srm.conf启动SSI。

　　首先登录到服务器，找到配置文件的存放目录，使用任何一种文字编辑器打开文件srm.conf，找到以下几行：

　　　　# If you want to use server side includes, or CGI outside
　　　　# ScriptAliased directories, uncomment the following lines.
　　　　#AddType text/x-server-parsed-html .shtml
　　　　#AddType application/x-httpd-CGI .CGI
　　注意, 高版本的Apache可能是这几行:
　　　　#
　　　　# To use server-parsed HTML files
　　　　#
　　　　#AddType text/html .shtml
　　　　#AddHandler server-parsed .shtml

　　用户的配置文件中可能没有上述的注释指令行，但是只要找到以AddType开头的两行并且去掉每一行最前面的"#"符号即可。

　　保存所做的修改，然后再打开文件access.conf。用户需要在文件中找到设置DocumentRoot（根文件）的部分。一般来说该段文本如下：

　　　　# This should be changed to whatever you set DocumentRoot to.
　　　　＜Directory /usr/local/etc/httpd/htdocs＞
　　　　# This may also be "None", "All", or any combination of "Indexes",
　　　　# "Includes", or "FollowSymLinks"
　　　　Options Indexes FollowSymLinks
　　　　＜/Directory＞
将其中的Options Indexes FollowSymLinks改为:
　　　　Options Indexes FollowSymLinks Includes

　　如果用户不希望执行脚本或shell命令，可以在options选项行中加入关键字IncludesNOEXEC，这样可以允许SSI，但是不能执行CGI或脚本命令（注：高版本的Apache服务器中,以上所提到的内容都已经被包含在配置文件httpd.conf中）。
2.创建文件.htaccess

　　如果用户不能直接访问服务器配置文件，可以使用文件编辑器创建一个名为.htaccess的文件。注意，文件名前一定要有符号"."，这样服务器才能知道该文件是隐藏文件，从而提高文件的安全性，以避免错误操作。在.htaccess文件中需要加入以下三行文字：

　　　　Options Indexes FollowSymLinks Includes
　　　　AddType application/x-httpd-CGI .CGI
　　　　AddType text/x-server-parsed-html .shtml

　　完成之后，可以把.htaccess文件上传到服务端的相应目录，该文件对所有子目录有效。如果用户希望在目录级上禁止CGI或shell命令，可以在.htaccess文件中的Options选项行加入关键字IncludesNOEXEC。

　　3.使用.shtml还是.html？

　　任何包含SSI的文件在下传到客户端之前，都必须经过服务器的解析过程。这样会增加服务器的负载，如果用户只希望在几个特殊页面中使用SSI，可以将文件的后缀名改为.shtml，这样服务器就可以只解析包含SSI的.shtml文件。另一方面，如果有多个页面使用了SSI，但是用户不希望使用.shtml的后缀名时，可以在.htaccess文件中使用以下命令行：

　　　　AddType text/x-server-parsed-html .html

　　怎样使用SSI?

　　SSI在使用时遵循以下格式：

　　　　＜!--#directive parameter="value"--＞

　　其中，directive是向服务器发送的指令名称，parameter是指令的操作对象，而value则是用户希望得到的指令处理结果。

　　所有的SSI命令都是以"＜!--#"开始，其中"＜!-"和"#"之间不能有任何空格，否则服务器会把SSI命令当称普通的文件注释处理，不会显示出任何结果，也不会产生错误提示。此外，SSI命令中的"="两边不能有空格，右边的值必须包含在双引号内，后面可以跟空格，最后是结束标签"--＞"。

　　SSI命令包含六大类指令以及各自的参数，具体如下：

指令名称	参数列表
Config	errmsg, timefmt, sizefmt
include	virtual, file
echo	var
fsize	file
flastmod	file
exec	cmd, cgi

下面我们将逐一进行介绍。

　　1、Config命令

　　Config命令主要用于修改SSI的默认设置。其中：

　　Errmsg：设置默认错误信息。为了能够正常的返回用户设定的错误信息，在HTML文件中Errmsg参数必须被放置在其它SSI命令的前面，否则客户端只能显示默认的错误信息，而不是由用户设定的自定义信息。

　　　　＜!--#config errmsg="Error! Please email [e-mail] --＞

　　Timefmt：定义日期和时间的使用格式。Timefmt参数必须在echo命令之前使用。

　　　　＜!--#config timefmt="%A, %B %d, %Y"--＞
　　　　＜!--#echo var="LAST_MODIFIED" --＞

　　显示结果为：

　　　　Wednesday, April 12, 2000

　　也许用户对上例中所使用的%A %B %d感到很陌生，下面我们就以表格的形式总结一下SSI中较为常用的一些日期和时间格式。

　　Sizefmt：决定文件大小是以字节、千字节还是兆字节为单位表示。如果以字节为单位，参数值为"bytes"；对于千字节和兆字节可以使用缩写形式。同样，sizefmt参数必须放在fsize命令的前面才能使用。

　　　　＜!--#config sizefmt="bytes" --＞
　　　　＜!--#fsize file="index.html" --＞

　　2、Include命令

　　Include命令可以把其它文档中的文字或图片插入到当前被解析的文档中，这是整个SSI的关键所在。通过Include命令只需要改动一个文件就可以瞬间更新整个站点！

　　Include命令具有两个不同的参数：

　　Virtual：给出到服务器端某个文档的虚拟路径。例如：

　　　　＜!--#include virtual="/includes/header.html" --＞

　　File：给出到当前目录的相对路径，其中不能使用"../"，也不能使用绝对路径。例如：

　　　　＜!--#include file="header.html" --＞

　　这就要求每一个目录中都包含一个header.html文件。

　　3、Echo命令

　　Echo命令可以显示以下各环境变量：

　　DOCUMENT_NAME：显示当前文档的名称。

　　　　＜!--#echo var="DOCUMENT_NAME" --＞

显示结果为：

　　　　index.html

　　DOCUMENT_URI：显示当前文档的虚拟路径。例如：

　　　　＜!--#echo var="DOCUMENT_URI" --＞

　　显示结果为：

　　　　/YourDirectory/YourFilename.html

　　随着网站的不断发展，那些越来越长的URL地址肯定会让人头疼。如果使用SSI，一切就会迎刃而解。因为我们可以把网站的域名和SSI命令结合在一起显示完整的URL，即：

　　http://YourDomain＜!--#echo var="DOCUMENT_URI" --＞

　　QUERY_STRING_UNESCAPED：显示未经转义处理的由客户端发送的查询字串，其中所有的特殊字符前面都有转义符"/"。例如：

　　＜!--#echo var="QUERY_STRING_UNESCAPED" --＞

　　DATE_LOCAL：显示服务器设定时区的日期和时间。用户可以结合config命令的timefmt参数，定制输出信息。例如：

　　＜!--#config timefmt="%A, the %d of %B, in the year %Y" --＞
　　＜!--#echo var="DATE_LOCAL" --＞

　　显示结果为：

　　Saturday, the 15 of April, in the year 2000

　　DATE_GMT：功能与DATE_LOCAL一样，只不过返回的是以格林尼治标准时间为基准的日期。例如：

　　＜!--#echo var="DATE_GMT" --＞

　　LAST_MODIFIED：显示当前文档的最后更新时间。同样，这是SSI中非常实用的一个功能，只要在HTML文档中加入以下这行简单的文字，就可以在页面上动态的显示更新时间。

　　＜!--#echo var="LAST_MODIFIED" --＞

　　CGI环境变量

　　除了SSI环境变量之外，echo命令还可以显示以下CGI环境变量：

　　　　SERVER_SOFTWARE：显示服务器软件的名称和版本。例如：
　　　　＜!--#echo var="SERVER_SOFTWARE" --＞
　　　　SERVER_NAME： 显示服务器的主机名称，DNS别名或IP地址。例如：
　　　　＜!--#echo var="SERVER_NAME" --＞
　　　　SERVER_PROTOCOL：显示客户端请求所使用的协议名称和版本，如HTTP/1.0。例如：
　　　　＜!--#echo var="SERVER_PROTOCOL" --＞
　　　　SERVER_PORT：显示服务器的响应端口。例如：
　　　　＜!--#echo var="SERVER_PORT" --＞
　　　　REQUEST_METHOD：显示客户端的文档请求方法，包括GET, HEAD, 和POST。例如：
　　　　＜!--#echo var="REQUEST_METHOD" --＞
　　　　REMOTE_HOST：显示发出请求信息的客户端主机名称。
　　　　＜!--#echo var="REMOTE_HOST" --＞
　　　　REMOTE_ADDR：显示发出请求信息的客户端IP地址。
　　　　＜!--#echo var="REMOTE_ADDR" --＞
　　　　AUTH_TYPE：显示用户身份的验证方法。
　　　　＜!--#echo var="AUTH_TYPE" --＞
　　　　REMOTE_USER：显示访问受保护页面的用户所使用的帐号名称。
　　　　＜!--#echo var="REMOTE_USER" --＞

、Fsize：显示指定文件的大小，可以结合config命令的sizefmt参数定制输出格式。

　　　　＜!--#fsize file="index_working.html" --＞

　　5、Flastmod：显示指定文件的最后修改日期，可以结合config 命令的timefmt参数控制输出格式。

　　　　＜!--#config timefmt="%A, the %d of %B, in the year %Y" --＞
　　　　＜!--#flastmod file="file.html" --＞

　　这里，我们可以利用flastmod参数显示出一个页面上所有链接页面的更新日期。方法如下：

　　　　＜!--#config timefmt=" %B %d, %Y" --＞
　　　　＜A HREF="/directory/file.html"＞File＜/A＞
　　　　＜!--#flastmod virtual="/directory/file.html" --＞
　　　　＜A HREF="/another_directory/another_file.html"＞Another File＜/A＞
　　　　＜!--#flastmod virtual="/another_directory/another_file.html" --＞
　　显示结果为：
　　　　File April 19, 2000
　　　　Another File January 08, 2000

　　6、Exec

　　Exec命令可以执行CGI脚本或者shell命令。使用方法如下：

　　　Cmd：使用/bin/sh执行指定的字串。如果SSI使用了IncludesNOEXEC选项，则该命令将被屏蔽。

　　　Cgi：可以用来执行CGI脚本。例如，下面这个例子中使用服务端cgi-bin目录下的counter.pl脚本程序在每个页面放置一个计数器：

　　　　＜!--#exec cgi="/cgi-bin/counter.pl" --＞