SSI -server side include-WEB服务器服务端包含

您是否曾或正在为如何能够在最短的时间内完成对一个包含上千个页面的网站的修改而苦恼？那么能够看一下本文的介绍，或许能够对您有所帮助。

什么是ssi？

　　ssi是英文server side includes的缩写，翻译成中文就是服务器端包含的意思。从技术角度上说，ssi就是html文档中，能够通过注释行调用的命令或指针。ssi 具备强大的功能，只要使用一条简单的ssi 命令就能够实现整个网站的内容更新，动态显示时间和日期，连同执行shell和cgi脚本程式等复杂的功能。ssi 能够称得上是那些资金短缺、时间紧张、工作量大的网站研发人员的最好帮手。

　　ssi最初在ncsa服务器平台上推出，在apache服务器中得到扩展和加强，现在已能够在几乎任何的服务器上运行。本文将主要结合apache服务器介绍ssi的使用方法。
 
如何启动ssi？

　　在apache服务器下，能够通过直接编辑服务器配置文档或在需要使用ssi的目录中创建.htaccess文档启动ssi。具体来说，过程如下：
 
1.服务器配置文档

　　假如用户具备对服务器配置文档的访问权限，能够通过编辑文档access.conf和srm.conf启动ssi。

　　首先使用telnet远程登录服务器，找到配置文档的存放目录。一般来说，apache服务器的配置文档都被保存在"/usr/local/etc/httpd/conf"目录下。使用任何一种文字编辑器打开文档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

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

　　保存所做的修改，然后再打开文档access.conf。用户需要在文档中找到配置documentroot（根文档）的部分。一般来说该段文本如下，但是不排除<directory>和</directory>标签之间还包含其他配置内容。

# 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 includes
</directory>

　　假如用户不希望执行脚本或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的话，确实没有必要让服务器解析每一个页面。假如用户只希望在几个特别页面中使用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命令包含六大类指令连同各自的参数，具体如下：
 
directives
parameters

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 webmaster@mydomain.com -->

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

<!--#config timefmt="%a, %b %d, %y"-->

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

显示结果为：

wednesday, april 12, 2000

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

格式
说明
实例

%%
%
　
%a
一周七天的缩写形式
thu

%a
一周七天
thursday

%b
月的缩写形式
apr

%b
月
april

%d
一个月内的第几天
13

%d
mm/dd/yy日期格式
04/13/00

%h
小时（24小时制，从00到23）
01

%i
小时（12小时制，从00到11）
01

%j
一年内的第几天，从01到365
104

%m
一年内的第几个月，从01到12
04

%m
一小时内的第几分钟，从00到59
10

%p
am或pm
am

%r
12小时制的当地时间，格式为%i:%m:%s am | pm
01:10:18 am

%s
一分钟内的第几秒，从00到59
18

%t
24小时制的%h:%m:%s时间格式
01:10:18

%u
一年内的第几个星期，从00到52，以星期天作为每个星期的第一天
15

%w
一星期内的第一天，从0到6
4

%w
一年内的第几个星期，从00到53，以星期一作为每个星期的第一天
15

%y
年的缩写形式，从00到99
00

%y
用四位数字表示一年
2000

%z
时区名称
mdt
 
　　sizefmt：决定文档大小是以字节、千字节还是兆字节为单位表示。假如以字节为单位，参数值为"bytes"；对于千字节和兆字节能够使用缩写形式。同样，sizefmt参数必须放在fsize命令的前面才能使用。

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

<!--#fsize file="index.html" -->

2.include命令

　　include命令能够把其他文档中的文字或图片插入到当前被解析的文档中，是整个ssi的关键所在。通过include命令只需要改变一个文档就能够瞬间更新整个站点！

　　include命令具备两个不同的参数，假如使用错误的参数更新站点的话，不但达不到初衷，反而会得到一大堆的错误信息。

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

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

　　为了更加合理的组织站点的内容，用户能够在根目录下创建includes子目录来存放任何的包含文档。virtual参数能够通知服务器所要包含的是个虚拟文档，即文档和当前被解析的文档不是位于同一个目录，而是存放在其他目录中。服务器会根据该参数的值找到根目录下的includes子目录。使用这种方法，用户能够把任何html文档包含的文档放在一个目录中，而根据相互之间的关系把不同的页面保存在不同的目录或子目录中。无论服务器解析哪一个文档都能够找到所包含的文档，不会产生任何错误。

　　但是这里有一个小问题需要解决。一般我们都会在页面中加入一些title和meta标签，假如我们规定任何的页面都调用相同的页眉文档的话，就显得很不灵活。用户碰到这样的问题时，能够使用两个包含文档，一个配置title标签前的内容，另一个配置meta标签后的部分，而在两个包含文档之间则能够添加任何定制内容。例如：

<!--#include virtual="/includes/header1.html" -->
<title>your page title</title>
<link rel = stylesheet href = "http://domain.com/styles/my.css" type = "text/css" >
<meta name = "description" content = " description of page">
<meta name = "keywords" content = "keywords for page" >
<!--#include virtual="/includes/header2.html" -->

这里放置页面内容

<!--#include virtual="/includes/footer.html" -->

　　从上我们能够看出通过在页面中包含页眉和页脚能够大大减少站点更新的工作量。但是假如我们希望动态显示一些内容，例如页面的最后更新时间等该怎么办呢？没问题，我们能够把包含文档使用.html后缀保存，这样就能够在包含文档中调用其他的包含文档。

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

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

　　这就需要每一个目录中都包含一个header.html文档。当然，采用这样的方法并不比更新每一个页面简单多少，但是假如用户只更新一、两个文档的话还是很方便的。例如，假如我们不希望让一个对html不熟悉的人直接改变网站中的新闻页面的话，能够只让他更新一个单独的文本文档，然后再把该文档包含到hmtl文档中，这样即不会破坏原页面，同时又更新了内容，两全其美。
 
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" -->
 
4.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

　　也许有的读者会认为两个链接就这么复杂，一点也不方便。其实，假如页面上有20个或更多的链接，而且每个链接都定期更新的话，就能够看出使用flastmod显示修改日期的作用。
 
6.exec

exec命令能够执行cgi脚本或shell命令。使用方法如下：

　　cmd：使用/bin/sh执行指定的字串。假如ssi使用了includesnoexec选项，则该命令将被屏蔽。

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

<!--#exec cgi="/cgi-bin/counter.pl" -->