shtml

shtml是標準通用標記語言下的一個套用，包含有嵌入式伺服器方包含命令的文本，在被傳送給瀏覽器之前，伺服器會對SHTML文檔進行完全地讀取、分析以及修改。

基本介紹

• 中文名：伺服器端包含
• 外文名：Server Side Include
• 外國語簡稱：ssi
• 檔案擴展名：SHTML（外國語簡稱）

簡介

shtml和asp 有一些相似，以shtml命名的檔案里，使用了ssi的一些指令，就像asp中的指令，你可以在SHTML檔案中寫入SSI指令，當客戶端訪問這些shtml檔案時，伺服器端會把這些SHTML檔案進行讀取和解釋，把SHTML檔案中包含的SSI指令解釋出來。

比如：你可以在SHTML檔案中用SSI指令引用其他的html檔案（#include ），伺服器傳送給客戶端的檔案，是已經解釋的SHTML，不會有SSI指令。它實現了HTML所沒有的功能，就是實現了動態的SHTML，可以說是HTML的一種進化吧。像新浪的新聞系統就是這樣的，新聞內容是固定的但它上面的廣告和選單等就是用#include引用進來的。

用途

主要有以下幾種用途：

1．顯示伺服器端環境變數<#echo>

2．將文本內容直接插入到文檔中<#include>

3．顯示WEB文檔相關信息<#flastmod #fsize> (如檔案製作日期/大小等)

4．直接執行伺服器上的各種程式<#exec>(如CGI或其他可執行程式)

5．設定SSI信息顯示格式<#config>(如檔案製作日期/大小顯示方式) 高級SSI<XSSI>可設定變數使用if條件語句。

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是為WEB伺服器提供的一套命令，這些命令只要直接嵌入到HTML文檔的注釋內容之中即可。如：

<!--#include file="info.htm"-->

就是一條SSI指令，其作用是將"info.htm"的內容拷貝到當前的頁面中，當訪問者來瀏覽時，會看到其它HTML文檔一樣顯示info.htm其中的內容。

其它的SSI指令使用形式基本同剛才的舉例差不多，可見SSI使用只是插入一點代碼而已，使用形式非常簡單。

當然，如果WEB伺服器不支持SSI，它就會只不過將它當作注釋信息，直接跳過其中的內容；瀏覽器也會忽略這些信息。

如何在我的WEB伺服器上配置SSI功能？

在一些WEB伺服器上（如IIS 4.0/SAMBAR 4.2），包含 #include 指令的檔案必須使用已被映射到 SSI解釋程式的擴展名；否則，Web 伺服器將不會處理該SSI指令；默認情況下，擴展名 .stm、.shtm 和 .shtml 被映射到解釋程式（Ssinc.dll）。

Apache則是根據你的設定情況而定，修改srm.conf如：AddType text/x-server-parsed-html

.shtml 將只對.shtml擴展名的檔案解析SSI指令

.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指令基本格式：

程式代碼:

<!-– 指令名稱="指令參數"-->

<!-– 指令名稱="指令參數"-->

如 程式代碼：

<!--#include file="info.htm"-->

<!--#include file="info.htm"-->

說明：

1．<!-- -->是HTML語法中表示注釋，當WEB伺服器不支持SSI時，會忽略這些信息。

2．#include 為SSI指令之一。

3．file 為include的參數，info.htm為參數值，在本指令中指將要包含的文檔名。

注意：

1．<!--與#號間無空格，只有SSI指令與參數間存在空格。

2．上面的標點=""，一個也不能少。

3．SSI指令是大小寫敏感的，因此參數必須是小寫才會起作用。

詳解

#echo 示範

作用：

將環境變數插入到頁面中。

語法：

程式代碼：

<!--#echo var="變數名稱"-->

本文檔名稱：程式代碼：

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

當前時間：程式代碼：

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

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

你的IP位址是程式代碼：

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

#include 示範

作用：

將文本檔案的內容直接插入到文檔頁面中。

語法：

程式代碼：

<!--#include file="檔案名稱稱"-->

<!--#include virtual="檔案名稱稱"-->

file 檔案名稱是一個相對路徑，該路徑相對於使用 #include 指令的文檔所在的目錄。被包含檔案可以在同一級目錄或其子目錄中，但不能在上一級目錄中。如表示當前目錄下的的nav_head.htm文檔，則為file="nav_head.htm"。

virtual 檔案名稱是 Web 站點上的虛擬目錄的完整路徑。如表示相對於伺服器文檔根目錄下hoyi目錄下的nav_head.htm檔案；則為virtual="/hoyi/nav_head.htm"

參數：

file 指定包含檔案相對於本文檔的位置

virtual 指定相對於伺服器文檔根目錄的位置

注意：

1．檔案名稱稱必須帶有擴展名。

2．被包含的檔案可以具有任何檔案擴展名，我覺得直接使用htm擴展名最方便，微軟公司推薦使用 .inc 擴展名（這就看你的愛好了）。

示例：

程式代碼：

<!--#include file="nav_head.htm"-->將頭檔案插入到當前頁面

<!--#include file="nav_foot.htm"-->將尾檔案插入到當前頁面

#flastmod 和#fsize 示範

作用：#flastmod 檔案最後一次更新日期

#fsize 檔案的長度

語法：

程式代碼：

<!--#flastmod file="檔案名稱稱"-->

<!--#fsize file="檔案名稱稱"-->

參數：

file 指定包含檔案相對於本文檔的位置 如 info.txt 表示當前目錄下的的info.txt文檔

virtual 指定相對於伺服器文檔根目錄的位置 如 /hoyi/info.txt 表示

注意：

檔案名稱稱必須帶有擴展名。

示例：

程式代碼：

<!--#flastmod file="news.htm"-->

將當前目錄下news.htm檔案的最後一次更新日期插入到當前頁面

程式代碼：

<!--#fsize file="news.htm"-->

將當前目錄下news.htm的檔案大小入到當前頁面

#exec 示範

作用：

將某一外部程式的輸出插入到頁面中。可插入CGI程式或者是常規應用程式的輸入，這取決於使用的參數是cmd還是cgi。

語法：

程式代碼：

<!--#exec cmd="檔案名稱稱"-->

<!--#exec cgi="檔案名稱稱"-->

參數：

cmd 常規應用程式

cgi CGI腳本程式

示例：

程式代碼：

<!--#exec cmd="cat /etc/passwd"-->將會顯示密碼檔案

<!--#exec cmd="dir /b"-->將會顯示當前目錄下檔案列表

<!--#exec cgi="/cgi-bin/gb.cgi"-->將會執行CGI程式gb.cgi。

<!--#exec cgi="/cgi-bin/access_log.cgi"-->將會執行CGI程式access_log.cgi。

注意：

從上面的示例可以看出，這個指令相當方便，但是也存在安全問題。

禁止方法：

．Apache，將access.conf中的"Options Includes ExecCGI"這行代碼刪除；

．在IIS中，要禁用 #exec 命令，可修改 SSIExecDisable 元資料庫；

#config

作用：指定返回給客戶端瀏覽器的錯誤信息、日期和檔案大小的格式。

語法：

程式代碼：

<!--#config errmsg="自定義錯誤信息"-->

<!--#config sizefmt="顯示單位"-->

<!--#config timefmt="顯示格式"-->

參數：

errmsg 自定義SSI執行錯誤信息，可以為任何你喜歡的方式。

sizefmt 檔案大小顯示方式，默認為位元組方式("bytes")可以改為千位元組方式("abbrev")

timefmt 時間顯示方式，最靈活的配置屬性。

示例：顯示一個不存在檔案的大小

程式代碼：

<!--#config errmsg="伺服器執行錯誤，謝謝！"-->

<!--#fsize file="不存在的檔案.htm"-->

以千位元組方式顯示檔案大小

程式代碼：

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

<!--#fsizefile="news.htm"-->

以特定的時間格式顯示時間

程式代碼：

<!--#config timefmt="%Y年/%m月%d日 星期%W 台北時間%H:%M:%s，%Y年已過去了%j天 今天是%Y年的第%U個星期"-->

<!--#echo var="DATE_LOCAL"--> 顯示今天是星期幾，幾月，時區

<!--#config timefmt="今天%A,%B,伺服器時區是 %z，是"-->

<!--#echo 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=\"bk.baidu .com\""-->

歡迎光臨百度。

<!--#elif expr="$SERVER_NAME=\"bk.baidu .com\"" -->

歡迎光臨百度知道。

<!--#else-->

歡迎光臨中文百科。

<!--#endif"-->

注意：用於前面指令中的反斜槓，是用來代換內部的引號，以便它們不會被解釋為結束表達式。不可省略。

命令

config

Config命令主要用於修改SSI的默認設定。其中：

Errmsg：設定默認錯誤信息。為了能夠正常的返回用戶設定的錯誤信息，在HTML檔案中Errmsg參數必須被放置在其它SSI命令的前面，否則客戶端只能顯示默認的錯誤信息，而不是由用戶設定的自定義信息。

<!--#config errmsg="Error! -->

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" -->

Include

Include命令可以把其它文檔中的文字或圖片插入到當前被解析的文檔中，這是整個SSI的關鍵所在。通過Include命令只需要改動一個檔案就可以瞬間更新整個站點！

Include命令具有兩個不同的參數：

Virtual：給出到伺服器端某個文檔的虛擬路徑。例如：

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

File：給出到當前目錄的相對路徑，其中不能使用"../"，也不能使用絕對路徑。例如：

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

這就要求每一個目錄中都包含一個header.html檔案。

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<!--#echovar="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" -->

flastmod

顯示指定檔案的最後修改日期，可以結合config 命令的timefmt參數控制輸出格式。

<!--#config timefmt="%A,the %d of %B,in the year %Y" -->

<!--#flastmod file="file.html" -->

這裡，我們可以利用flastmod參數顯示出一個頁面上所有連結頁面的更新日期。方法如下：

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

File

<!--#flastmod virtual="/directory/file.html" -->

Another File

<!--#flastmod virtual="/another_directory/another_file.html" -->

顯示結果為：

File April 19,2000

Another File January 08,2000

exec

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

Cmd：使用/bin/sh執行指定的字串。如果SSI使用了IncludesNOEXEC選項，則該命令將被禁止。

Cgi：可以用來執行CGI腳本。例如，下面這個例子中使用服務端cgi-bin目錄下的counter .pl腳本程式在每個頁面放置一個計數器

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

指令區別

SHTML和HTML的區別，如果用一句話來解釋就是：SHTML 不是HTML而是一種伺服器API,shtml可通過伺服器動態產成html. 雖然兩者都是超文本格式，但shtml是一種用於SSI技術的檔案。也就是Server Side Include--SSI伺服器端包含指令。如果Web Server有SSI功能的話(大多數（尤其是基於Unix平台）的WEB伺服器如Netscape Enterprise Server等均支持SSI命令)。會對shtml檔案特殊招待。先掃一次shtml檔案看有沒有特殊的SSI指令存在。有就按Web Server設定規則解釋SSI指令。解釋完後跟一般html一起調去客戶端。html或htm與shtml或shtm的關係是什麼？html或者htm是一種靜態的頁面格式，也就是說不需要伺服器解析其中的腳本，或者說裡面沒有伺服器端執行的腳本，而shtml或者shtm由於它基於SSI技術，當有伺服器端可執行腳本時被當作一種動態程式語言來看待，就如asp、jsp或者php一樣。當shtml或者shtm中不包含伺服器端可執行腳本時其作用和html或者htm是一樣的。