SSI详解 – zcw的博客

转载，来自：http://omiga.org/blog/archives/2069

SSI（Server Side Include）使用在HTML中，用于在请求内容返回到客户端前执行页面中的SSI命令，生成动态内容。通常用于多个页面引用公共的内容模块，将此模块分离出来，使用SSI引入即可。

<!--#include virtual="/inc/header.html"-->

1	<!--#include virtual="/inc/header.html"-->

以上代码便能在服务端完成header.html的动态引入，非常简单。

服务端配置

使用SSI之前需要服务端进行简单的配置，开启SSI功能。SSI是针对HTML增加动态内容的技术，所以只对HTML类型文件（.html,.shtml），使用SSI功能的文件建议使用.shtml后缀，便于维护。如果使用.shtml后缀需在服务端作一些配置：

AddType text/html .shtml
AddOutputFilter INCLUDES .shtml

1 2	AddType text/html .shtml AddOutputFilter INCLUDES .shtml

第一行命名配置将.shtml作为html文件返回

第二行命令用于在返回请求内容前执行页面中的SSI命令，如果你在.html文件中使用SSI，那么将.shtml改为.html即可。

SSI命令

SSI的语法有点像HTML注释，所以如果SSI不能识别，那么将被视作HTML注释处理。SSI的语法功能主要包括：变量的设置/获取，文件的引用，可执行命令，条件表达式等。

SSI基本语法

<!--#command param="value"-->

1	<!--#command param="value"-->

SSI的语法非常简单，但使用中需注意以下几点：

<!–与#之间无空格
SSI大小写敏感
所有value需写在引号中

config命令

config命令主要用于修改SSI的默认设置，诸如时间格式，默认错误信息，文件大小单位。

设置默认错误信息：errmsg

<!--#config errmsg="Error,please contact webmaster@mail.com"-->

1	<!--#config errmsg="Error,please contact webmaster@mail.com"-->

定义日期和时间格式：timefmt

<!--#config timefmt="%A, %B %d, %Y"-->

1	<!--#config timefmt="%A, %B %d, %Y"-->

定义文件大小单位

<!--#config sizefmt="bytes"-->

1	<!--#config sizefmt="bytes"-->

config命令只对其后使用的命令生效。同时，后定义的设置具有更高的优先级，会覆盖之前的设置。

include命令

include命名可能是SSI中使用最多的命令，也是SSI最主要的功能体现，include命令可以将其他文件引用到当前文档中。

<!--#include virtual="/inc/header.inc"-->
<!--#include file="inc/desc.inc"-->

1 2	<!--#include virtual="/inc/header.inc"--> <!--#include file="inc/desc.inc"-->

include命令支持通过虚拟路径引入文件（virtual），以及相对路径引入文件（file）。

include命令支持引用任何类型的文件，不过我建议最好将需要引入的文件名后缀设置为.inc，或放入固定的文件目录，方便管理。

set命令

使用SSI同样可以使用set进行变量的定义：

<!--#set var="blog" value="http://omiga.org/"-->

1	<!--#set var="blog" value="http://omiga.org/"-->

变量定义后便可以使用了：

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

1	<!--#echo var="blog"-->

定义变量时使用环境变量：

1	定义变量时使用环境变量：

<!--#set var="fname" value="${DOCUMENT_NAME}${DOCUMENT_URI}"-->

1	<!--#set var="fname" value="${DOCUMENT_NAME}${DOCUMENT_URI}"-->

如果是单个环境变量可以不使用{}分割：

<!--#set var="fname" value="$DOCUMENT_NAME"-->

1	<!--#set var="fname" value="$DOCUMENT_NAME"-->

环境变量的引用都需要使用$前缀，如果$仅作为字符使用，通过\$转义即可。

echo命令

echo显示变量值，包括自定义变量、环境变量

<!–#echo var=”DOCUMENT_NAME”–>

注意：echo命令中使用的环境变量不需要使用$前缀。

SSI的主要环境变量如下：

name	description	type
DOCUMENT_NAME	当前文档名	SSI
DOCUMENT_URI	当前文档虚拟路径	SSI
QUERY_STRING_UNESCAPED	未经转义处理的由客户端发送的查询字串，所有的特殊字符前面都有转义符”\”	SSI
DATE_LOCAL	服务器设定时区的日期和时间	SSI
DATE_GMT	功能与DATE_LOCAL一样，但返回的是以格林尼治标准时间为基准的日期	SSI
LAST_MODIFIED	当前文档的最后更新时间	SSI
SERVER_SOFTWARE	服务器软件的名称和版本	CGI
SERVER_NAME	服务器的主机名称，DNS别名或IP地址	CGI
SERVER_PROTOCOL	客户端请求所使用的协议名称和版本	CGI
SERVER_PORT	服务器的响应端口	CGI
REMOTE_HOST	发出请求信息的客户端主机名称	CGI
REMOTE_ADDR	发出请求信息的客户端IP地址	CGI
AUTH_TYPE	用户身份的验证方法	CGI
REMOTE_USER	访问受保护页面的用户所使用的帐号名称	CGI

更多的环境变量可使用printenv命令查看

printenv命令

显示所有环境变量

<!--#printenv -->

1	<!--#printenv -->

fsize命令

显示指定文件的大小，可结合config sizefmt指定输出格式。

<!--输出当前文档大小-->
<!--#fsize file="$DOCUMENT_NAME"-->
<!--#fsize virtual="$DOCUMENT_URI"-->

flastmod命令

显示指定文件的最后更新日期，可结合config sizefmt指定输出格式。

<!--输出当前文档大小-->
<!--#flastmod file="$DOCUMENT_NAME"-->
<!--#flastmod virtual="$DOCUMENT_URI"-->

exec命令

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

CMD：使用 /bin/sh 执行指定的字串。如果 SSI 使用了 IncludesNOEXEC 选项，则该命令将被屏蔽
CGI：可以用来执行 CGI 脚本

if…语句

SSI中也可以是用条件判断语句if，语法如下：

<!--#if expr="test_condition" -->
<!--#elif expr="test_condition" -->
<!--#else -->
<!--#endif -->

示例：

<!--#if expr="$DOCUMENT_NAME=index.shtml"-->
<p>这是通过if判断当前文档名为"index.shtml"后显示</p>
<!--#elif expr="$DOCUMENT_NAME=index.html"-->
<p>这是通过if判断当前文档名为"index.html"后显示</p>
<!--#else -->
<p>既不是"index.shtml"，也不是"index.html"</p>
<!--#endif -->

这是通过if判断当前文档名为"index.shtml"后显示

这是通过if判断当前文档名为"index.html"后显示

既不是"index.shtml"，也不是"index.html"

demo

SSI还是在之前公司的使用经常用，好几月不用，所剩已经寥寥。挺好的技术，而且简单方便，于是整理篇文章记录一下。