Apache指南：服务器端包含入门

概要

相关模块	相关指令
mod_include mod_cgi mod_expires	Options XBitHack AddType SetOutputFilter BrowserMatchNoCase

本文针对服务器端包含(Server Side Includes)，通常简称为SSI，讨论如何配置服务器以允许SSI，并介绍一些对现有HTML页面增加动态内容的基本SSI技术。

本文后部将讨论用SSI做一些应该算比较高级的事情，比如SSI指令中的条件语句。

什么是SSI?

SSI (Server Side Includes)是HTML页面中的指令，在页面被提供时由服务器进行运算，以对现有HTML页面增加动态生成的内容，而无须通过CGI程序提供其整个页面，或者使用其他动态技术。

对什么时候用SSI，而什么时候用某些程序生成整个页面的权衡，取决于页面中有多少内容是静态，有多少内容需要在每次页面被提供时重新计算。SSI是一种增加小段信息的好方法，诸如当前时间。如果你的页面大部分是在被提供时生成的，那就要另找方案了。

配置服务器以允许SSI

要使服务器允许SSI，必须在httpd.conf文件或.htaccess文件中有如下配置：

告诉服务器以允许解析文件中的SSI指令。注意，在多数配置中，多个Options指令会互相覆盖，所以，可能必须对需要SSI的特定目录使用Options，以确保位于最后并起作用。

并不是所有文件中的SSI指令都会被解析，所以，必须告诉Apache应该解析哪些文件。有两种方法，使Apache解析带有特定文件后缀的任何文件，比如.shtml, 配置如下：

这种方法的缺点之一是，为了使文件名有.shtml后缀从而执行其中的指令，可能需要改变加入SSI指令的现有的文件，以及所有指向此页面的连接。

另一种方法是，使用XBitHack指令：

XBitHack告诉Apache解析有执行权限的文件中的SSI指令。如此，只要用chmod使文件变成可执行的，就可以对现有的页面增加SSI指令。

这里简要说明一点：偶然会有人向你推荐，无须用带.shtml的文件名，使Apache解析所有.html文件的SSI就可以了。那些人可能没听说过XBitHack。要知道，这样做会使Apache在发送文件到客户端之前通读此文件，即使其中并没有任何SSI指令，从而对速度有不小影响，所以这并不是好办法。

当然，在Windows上，没有对应的执行权限可以设置，但还是应该谨慎选择。

按缺省配置，Apache不会为SSI页面发送最后修改日期或者内容长度的HTTP头，因为这些值对动态页面来说难以计算。这样会阻止页面被缓冲，导致客户端性能有能够感觉到的下降。有两种解决方法：

1. 使用XBitHack Full配置。它告诉Apache判断最后修改日期时，只查看被请求的文件本身的日期，而忽略其中包含的任何文件的修改日期。
2. 使用mod_expires提供的指令为文件设置一个明确的过期时间，并告诉浏览器和代理这个文件可以被缓冲。

基本SSI指令

SSI指令有如下语法：

其格式很象HTML的注释，因此如果没有正确配置SSI，它会被浏览器忽略，但在HTML代码中仍然可见。而如果正确配置了SSI，则此指令会被其结果替代。

其中的元素可以有许多，我们会在下一个版本的文档中讨论其中的大多数，而在这里，仅举几个SSI的例子。

今天的日期

echo元素仅仅是反馈一个变量的值。标准变量有许多，其中包含对CGI程序有效的所有的环境变量。另外，你也可以用set元素定义你的专用变量。

如果你不喜欢日期的这种打印格式，可以用config元素的timefmt属性，改变其格式。

文件的修改日期

这个元素也是使用timefmt的格式配置。

包含一个CGI程序的输出

这是SSI的很常见的一个用途-包含一个CGI程序的输出，比如人人喜欢的``点击计数器''。

附加的例子

以下是一些对HTML文档使用SSI的特殊例子。

文档是什么时候被修改的?

此前，我们提到过可以用SSI通知用户文档是什么时候被修改的，但是其具体实施方法却基本上是个问题。以下代码，放在HTML文档中，会在页面中产生一个时间戳，当然，首先，你必须按上述方法使SSI有效。

不用说，你应该用你实际引用的文件名来替换ssi.shtml，所以，如果你想简单地在任何文件中粘贴一段通用代码以达到这个目的，这个方法就并不方便，如此，就会用到LAST_MODIFIED变量：

有关timefmt格式的细节，可以到搜索站点查找strftime，其语法是相同的。

包含一个标准注脚

如果你管理一个拥有许多页面的站点，你会发现对所有页面做改动是很痛苦的，尤其是在试图对所有页面维持某种标准观感的时候。

使用包含一个页眉和/或注脚的方法，可以减轻修改的负担。你只要制作一个注脚文件，并用includeSSI命令包含到每个页面，即可。include元素能按file属性或者virtual属性判断应该包含的文件。file属性是一个相对于当前目录的文件路径，即不能是一个绝对文件路径(以/开头)。virtual属性可能更有用，它是一个相对于被提供文档的URL，可以以/开头，但必须与被提供文档在同一个服务器。

SSI指令和注脚文件相结合使用是很有用的，比如在注脚文件中使用LAST_MODIFIED指令。SSI指令可以出现在包含文件中，而include可以嵌套，即一个包含文件可以包含另一个。

其他的设置

config除了能设置时间格式，还有两种用途。

当SSI指令发生错误时，会产生如下消息：

为了改变消息的形式，可以使用config元素的errmsg属性：

当然，最终用户永远也不会看到这个消息，因为在网站投入运行之前你已经把这些问题都解决了(是吗？)。

还可以使用config的sizefmt属性设置返回的文件大小的格式，或者是以字节为单位，或者是以Kb或Mb为单位的简写。

执行命令

我期望未来几个月内能再写一篇小型CGI程序使用SSI的文章，而这里，仅介绍exec的使用。SSI确实可以利用shell(/bin/sh，精确地说，还可以是Win32中的DOS shell)来执行命令。下例产生一个目录列表：

在Windows中：

你可能会发现，在Windows中这个指令的结果有些奇怪，dir的输出中包含有字串``<dir>''，它会使浏览器产生混淆。

注意，这个功能是极度危险的，因为它会执行任何包含在exec标记中的命令。如果用户有可能修改你的网页内容，比如“留言本”，那么你一定要关闭这个功能。在Options指令中加上IncludesNOEXEC参数，以关闭exec功能，同时又保留SSI。

高级SSI技术

除了分离内容，Apache SSI还可以设置用以比较和条件表达式的变量。

警告

本文中讨论的大多数功能仅在Apache 1.2及更新版本中有效。如果你运行的不是Apache 1.2及更新版本，请立刻或者尽快升级，现在就动手，我们会等你弄好了再继续往下讲。

设置变量

使用set指令可以设置变量以备后用，其语法是：

除了设置文字变量以外，还可以设置其他任何变量，比如环境变量和此前提到过的一些变量(如LAST_MODIFIED)，作为你的专用变量。在变量名前面缀以$，表示它是一个变量，而不是一个文字性字串。

在文字性字串中使用$，必须使用转义符号\

最后，如果要在较长的字符串中使用变量，可以用花括号把变量名括起来，以免变量名与其他字符之间冲突而产生混淆(要对这种情况举例说明有点难度，但还是希望你能领会)。

条件表达式

有了变量，就可以设置和比较它们的值以表示条件，SSI也因此成为一种简洁的编程语言。mod_include提供了if, elif, else和endif等结构以构造条件语句，从而对一个实在的页面高效地生成多个逻辑的页面。

条件的结构如下：

test_condition可以是任何逻辑比较 - 可以是一个值和另一个值比较，也可以是测试一个特定的值是否为“真”(一个给定的字串如果非空则为真)。完整的比较操作符列表，见mod_include。以下是可能会用到的一些例子。

在配置文件中，可以这样设置：

如果客户端在Macintosh上运行Internet Explorer，则上例设置环境变量``Mac'' 和``InternetExplorer''为真。

然后，在允许SSI的文档中，可以这样设置：

我一点也不反对在Mac上运行IE - 只是上个星期我花了好几个小时试图在Mac上的IE中使用JavaScript，而它在其他地方都能正常运作，以上只是一个临时的妥协方案。

任何其他变量(或者是你定义的，或者是标准的环境变量)都可以用于条件语句。利用Apache的SetEnvIf以及其他相关指令设置环境变量，此功能可以很好地实现动态页面而无须借助于CGI。

总结

SSI固然不能替代CGI或者其他动态页面技术，但它是在页面中插入众多小型的动态片段的优秀方法，而无须大量额外的操作。