SHTML 教程

来源:互联网 发布:三国志13名将模型数据 编辑:程序博客网 时间:2024/04/29 22:56
什么是 SHTML
使用SSI(Server Side Include)的html文件扩展名,SSI(Server Side Include)

,通常称为“服务器端嵌入”或者叫“服务器端包含”,是一种类似于ASP的基于服

务器的网页制作技术。

SSI工作原理:
将内容发送到浏览器之前,可以使用“服务器端包含 (SSI)”指令将文本、图形或应

用程序信息包含到网页中。例如,可以使用 SSI 包含时间/日期戳、版权声明或供客

户填写并返回的表单。对于在多个文件中重复出现的文本或图形,使用包含文件是一

种简便的方法。将内容存入一个包含文件中即可,而不必将内容输入所有文件。通过

一个非常简单的语句即可调用包含文件,此语句指示 Web 服务器将内容插入适当网

页。而且,使用包含文件时,对内容的所有更改只需在一个地方就能完成。

因为包含 SSI 指令的文件要求特殊处理,所以必须为所有 SSI 文件赋予 SSI 文件

扩展名。默认扩展名是 .stm、.shtm 和 .shtml。

Web 服务器在处理网页的同时处理 SSI 指令。当 Web 服务器遇到 SSI 指令时,直

接将包含文件的内容插入 HTML 网页。如果“包含文件”中包含 SSI 指令,则同时

插入此文件。除了用于包含文件的基本指令之外,还可以使用 SSI 指令插入文件的

相关信息(如文件的大小)或者运行应用程序或 shell 命令。

网站维护常常碰到的一个问题是,网站的结构已经固定,却为了更新一点内容而不得

不重做一大批网页。SSI提供了一种简单、有效的方法来解决这一问题,它将一个网

站的基本结构放在几个简单的HTML文件中(模板),以后我们要做的只是将文本传到

服务器,让程序按照模板自动生成网页,从而使管理大型网站变得容易。

所以,利用SHTML格式的页面目的和 ASP 差不多,但是因为是 API 所以运转速度更

快,效率更高,比ASP快,比HTML慢,但由于可以使用服务器端包含,因此使页面更

新容易(特别是批量更新banner,版权等),想象一下吧,你有一段 HTML,要在中

间穿插一些特殊的服务端脚本,比如插入其他 HTML 段落,你选择 ASP 来完成这个

任务,但是如果任务更繁重,需要更多的时间,比如 5 s,这个时候你不用 ASP 而

用  SHTML,或许处理时间就只用 4s 了。

SSI有什么用?
之所以要扯到 SSI,是因爲 Shtml - Server-Parsed HTML 的首字母缩略词。包含有

嵌入式服务器方包含命令的 HTML 文本。在被传送给浏览器之前,服务器会对 SHTML 

文档进行完全地读取、分析以及修改。shtml和asp 有一些相似,以shtml命名的文件

里,使用了ssi的一些指令,就像asp中的指令,你可以在SHTML文件中写入SSI指令,

当客户端访问这些shtml文件时,服务器端会把这些SHTML文件进行读取和解释,把

SHTML文件中包含的SSI指令解释出来比如:你可以在SHTML文件中用SSI指令引用其他

的html文件(#i nclude ),服务器传送给客户端的文件,是已经解释的SHTML不会有

SSI指令。它实现了HTML所没有的功能,就是可以实现了动态的SHTML,可以说是HTML

的一种进化吧。像新浪的新闻系统就是这样的,新闻内容是固定的但它上面的广告和

菜单等就是用#i nclude引用进来的。

目前,主要有以下几种用用途:

显示服务器端环境变量<#e cho> 
将文本内容直接插入到文档中<#i nclude> 
显示WEB文档相关信息<#f lastmod #f size> (如文件制作日期/大小等) 
直接执行服务器上的各种程序<#e xec>(如CGI或其他可执行程序) 
设置SSI信息显示格式<#c onfig>(如文件制作日期/大小显示方式)
高级SSI<XSSI>可设置变量使用if条件语句。

使用SSI
SSI是为WEB服务器提供的一套命令,这些命令只要直接嵌入到HTML文档的注释内容之

中即可。如:

<!--#i nclude file="info.htm"-->

就是一条SSI指令,其作用是将"info.htm"的内容拷贝到当前的页面中,当访问者来

浏览时,会看到其它HTML文档一样显示info.htm其中的内容。其它的SSI指令使用形

式基本同刚才的举例差不多,可见SSI使用只是插入一点代码而已,使用形式非常简

单。当然,如果WEB服务器不支持SSI,它就会只不过将它当作注释信息,直接跳过其

中的内容;浏览器也会忽略这些信息。

如何在我的WEB服务器上配置SSI功能?
在一些WEB服务器上(如IIS 4.0/SAMBAR 4.2),包含 #i nclude 指令的文件必须使

用已被映射到 SSI 解释程序的扩展名;否则,Web 服务器将不会处理该SSI指令;默

认情况下,扩展名 .stm、.shtm 和 .shtml 被映射到解释程序(Ssinc.dll)。
Apache则是根据你的设置情况而定,修改srm.conf如:

AddType text/x-server-parsed-html .shtml 将只对.shtml扩展名的文件解析SSI指


AddType text/x-server-parsed-html .html 将对所有HTML文档解析SSI指令

Netscape WEB服务器直接使用 Administration Server(管理服务器)可打开SSI功能


Website 使用 Server Admin 程序中的 Mapping 标签,扩展名添加内容类型为:

wwwserver/html-ssi
Cern 服务器不支持SSI,可用SSI诈骗法,到 

http://sw.cse.bris.ac.uk/WebTools/fakessi.html 上下载一个PERL脚本,即可使

你的CERN服务器使用一些SSI指令。(不支持exec指令。)

SSI指令基本格式
程序代码:

<!-- 指令名称="指令参数">

示例:

<!--#i nclude file="info.htm"-->

说明:

<!-- -->是HTML语法中表示注释,当WEB服务器不支持SSI时,会忽略这些信息。
#i nclude 为SSI指令之一。
file 为include的参数, info.htm为参数值,在本指令中指将要包含的文档名。
注意:

<!--与#号间无空格,只有SSI指令与参数间存在空格。
上面的标点="",一个也不能少。
SSI指令是大小写敏感的,因此参数必须是小写才会起作用。
SSI指令使用详解
#e cho 示范

作用:将环境变量插入到页面中。

语法:

<!--#e cho var="变量名称"-->

示例:

<!--#e cho var="DOCUMENT_NAME"--> 本文档名称
<!--#e cho var="DATE_LOCAL"--> 现在时间
<!--#e cho var="REMOTE_ADDR"--> 你的IP地址

#i nclude 示范

作用:将文本文件的内容直接插入到文档页面中。

语法:

<!--#i nclude file="文件名称"-->
<!--#i nclude virtual="文件名称"-->

file 文件名是一个相对路径,该路径相对于使用 #i nclude 指令的文档所在的目录

。被包含文件可以在同一级目录或其子目录中,但不能在上一级目录中。如表示当前

目录下的的nav_head.htm文档,则为file="nav_head.htm"。
virtual 文件名是 Web 站点上的虚拟目录的完整路径。如表示相对于服务器文档根

目录下hoyi目录下的nav_head.htm文件;则为file="/hoyi/nav_head.htm"

参数:

file 指定包含文件相对于本文档的位置
virtual 指定相对于服务器文档根目录的位置

注意:

文件名称必须带有扩展名。 
被包含的文件可以具有任何文件扩展名,我觉得直接使用htm扩展名最方便,微软公

司推荐使用 .inc 扩展名(这就看你的爱好了)。
示例:

<!--#i nclude file="nav_head.htm"--> 将头文件插入到当前页面
<!--#i nclude file="nav_foot.htm"--> 将尾文件插入到当前页面

#f lastmod 和 #f size 示范

作用:

#f lastmod 文件最近更新日期
#f size 文件的长度

语法:

<!--#f lastmod file="文件名称"-->
<!--#f size file="文件名称"-->

参数:

file 指定包含文件相对于本文档的位置 如 info.txt 表示当前目录下的的info.txt

文档
virtual 指定相对于服务器文档根目录的位置 如 /hoyi/info.txt 表示

注意:文件名称必须带有扩展名。

示例:

<!--#f lastmod file="news.htm"--> 将当前目录下news.htm文件的最近更新日期插

插入到当前页面
<!--#f size file="news.htm"--> 将当前目录下news.htm的文件大小入到当前页面

#e xec 示范

作用:将某一外部程序的输出插入到页面中。可插入CGI程序或者是常规应用程序的

输入,这取决于使用的参数是cmd还是cgi。

语法:

<!--#e xec cmd="文件名称"-->
<!--#e xec cgi="文件名称"-->

参数:

cmd 常规应用程序
cgi CGI脚本程序

示例:

<!--#e xec cmd="cat /etc/passwd"--> 将会显示密码文件
<!--#e xec cmd="dir /b"--> 将会显示当前目录下文件列表
<!--#e xec cgi="/cgi-bin/gb.cgi"--> 将会执行CGI程序gb.cgi。
<!--#e xec cgi="/cgi-bin/access_log.cgi"--> 将会执行CGI程序access_log.cgi。

注意:从上面的示例可以看出,这个指令相当方便,但是也存在安全问题。

禁止方法:

Apache,将access.conf中的"Options Includes ExecCGI"这行代码删除;
在IIS中,要禁用 #e xec 命令,可修改 SSIExecDisable 元数据库;
#c onfig

作用: 指定返回给客户端浏览器的错误信息、日期和文件大小的格式。

语法:

<!--#c onfig errmsg="自定义错误信息"-->
<!--#c onfig sizefmt="显示单位"-->
<!--#c onfig timefmt="显示格式"-->

参数:

errmsg 自定义SSI执行错误信息,可以为任何你喜欢的方式。
sizefmt 文件大小显示方式,默认为字节方式("bytes")可以改为千字节方式

("abbrev")
timefmt 时间显示方式,最灵活的配置属性。

示例:显示一个不存在文件的大小

<!--#c onfig errmsg="服务器执行错误,请联系管理员 yiho@126.com,谢谢!"-->
<!--#f size file="不存在的文件.htm"-->

以千字节方式显示文件大小

语法:

<!--#c onfig sizefmt="abbrev"-->
<!--#f sizefile="news.htm"-->

以特定的时间格式显示时间

<!--#c onfig timefmt="%Y年/%m月%d日 星期%W 北京时间%H:%M:%s,%Y年已过去了%j

天 今天是%Y年的第%U个星期"-->
<!--#e cho var="DATE_LOCAL"--> 显示今天是星期几,几月,时区
<!--#c onfig timefmt="今天%A, %B ,服务器时区是 %z,是"-->
<!--#e cho var="DATE_LOCAL"-->

XSSI
XSSI(Extended SSI)是一组高级SSI指令,内置于Apache 1.2或更高版本的

mod-include模块之中。其中可利用的的指令有:

#printenv
#set
#if

#printenv

作用: 显示当前存在于WEB服务器环境中的所有环境变量。

语法:

<!--#printenv-->

#set

作用:可给变量赋值,以用于后面的if语句。

语法:

<!--#set var="变量名" value="变量值"-->


示例:

<!--#set var="color" value="红色"-->


#if

作用:创建可以改变数据的页面,这些数据根据使用if语句时计算的要求予以显示。

语法:

<!--#if expr="$变量名=/"变量值A/""-->
  显示内容
<!--#elif expr="$变量名=/"变量值B/""-->
  显示内容
<!--#else-->
  显示内容
<!--#endif"-->

示例:

<!--#if expr="$SERVER_NAME=/"hoyi.zb169.net/""-->
  欢迎光临好易CGI工厂在淄博热线的分站 http://hoyi.zb169.net
<!--#elif expr="$SERVER_NAME=/"linux.cqi.com.cn/"" -->
  欢迎光临好易CGI工厂在太阳城的分站 http://linux.cqi.com.cn/~hoyi
<!--#else-->
  欢迎光临好易CGI工厂!
<!--#endif"-->

注意:用于前面指令中的反斜杠,是用来代换内部的引号,以便它们不会被解释为结

束表达式。不可省略。

1、Config 命令

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

Errmsg:设置默认错误信息。为了能够正常的返回用户设定的错误信息,在HTML文件

中Errmsg参数必须被放置在其它SSI命令的前面,否则客户端只能显示默认的错误信

息,而不是由用户设定的自定义信息。

<!--#c onfig errmsg="Error! Please email webmaster@mydomain.com" -->

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

<!--#c onfig timefmt="%A, %B %d, %Y"-->
<!--#e cho var="LAST_MODIFIED" -->

显示结果为:

Wednesday, April 12, 2000

也许用户对上例中所使用的%A %B %d感到很陌生,下面我们就以表格的形式总结一下

SSI中较为常用的一些日期和时间格式。

Sizefmt:决定文件大小是以字节、千字节还是兆字节为单位表示。如果以字节为单

位,参数值为"bytes";对于千字节和兆字节可以使用缩写形式。同样,sizefmt参数

必须放在fsize命令的前面才能使用。

<!--#c onfig sizefmt="bytes" -->
<!--#f size file="index.html" -->

2、Include 命令

Include 命令可以把其它文档中的文字或图片插入到当前被解析的文档中,这是整个

SSI的关键所在。通过Include命令只需要改动一个文件就可以瞬间更新整个站点!

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

Virtual:给出到服务器端某个文档的虚拟路径。
File:给出到当前目录的相对路径,其中不能使用"../",也不能使用绝对路径。

<!--#i nclude virtual="/includes/header.html" -->
<!--#i nclude file="header.html" --> 这就要求每一个目录中都包含一个

header.html文件。

3、Echo 命令

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

DOCUMENT_NAME:显示当前文档的名称。
DOCUMENT_URI:显示当前文档的虚拟路径。例如:

<!--#e cho var="DOCUMENT_NAME" -->
<!--#e cho var="DOCUMENT_URI" -->

随着网站的不断发展,那些越来越长的URL地址肯定会让人头疼。如果使用SSI,一切

就会迎刃而解。因为我们可以把网站的域名和SSI命令结合在一起显示完整的URL,即



http://YourDomain
<!--#e cho var="DOCUMENT_URI" -->

QUERY_STRING_UNESCAPED:显示未经转义处理的由客户端发送的查询字串,其中所有

的特殊字符前面都有转义符"/"。例如:

<!--#e cho var="QUERY_STRING_UNESCAPED" -->

DATE_LOCAL:显示服务器设定时区的日期和时间。用户可以结合config命令的

timefmt参数,定制输出信息。例如:

<!--#c onfig timefmt="%A, the %d of %B, in the year %Y" -->
<!--#e cho var="DATE_LOCAL" -->

显示结果为:

Saturday, the 15 of April, in the year 2000

DATE_GMT:功能与DATE_LOCAL一样,只不过返回的是以格林尼治标准时间为基准的日

期。例如:

<!--#e cho var="DATE_GMT" -->

LAST_MODIFIED:显示当前文档的最后更新时间。同样,这是SSI中非常实用的一个功

能,只要在HTML文档中加入以下这行简单的文字,就可以在页面上动态的显示更新时

间。

<!--#e cho var="LAST_MODIFIED" -->

CGI环境变量

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

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

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



<!--#f size file="index_working.html" -->

5、Flastmod:显示指定文件的最后修改日期,可以结合config 命令的timefmt参数

控制输出格式。

<!--#c onfig timefmt="%A, the %d of %B, in the year %Y" -->
<!--#f lastmod file="file.html" -->

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

如下:

<!--#c onfig timefmt=" %B %d, %Y" -->
<A HREF="/directory/file.html">File</A>
<!--#f lastmod virtual="/directory/file.html" -->
<A HREF="/another_directory/another_file.html">Another File</A>
<!--#f lastmod 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脚本程序在每个页面放置一个计数器:

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

关于SHTML和HTML的区别
让我们先来看看SHTML和HTML的区别,如果用一句话来解释就是:SHTML 不是HTML而是

一种服务器 API,shtml是服务器动态产成的html.

虽然两者都是超文本格式,但shtml是一种用于SSI技术的文件。也就是Server Side 

Include--SSI 服务器端包含指令。如果Web Server有SSI功能的话,大多数(尤其是

基于Unix平台)的WEB服务器,如Netscape Enterprise Server等均支持SSI命令。