Webmin 技術內幕
金戈 (jinge@cn.ibm.com)
IBM軟體工程師
2002 年 1 月
本文是對 Webmin介紹的第二部分，著重探討 Webmin的技術內幕和如何編寫 Webmin模塊。文中首先介紹剖析了 Webmin內部結構，然後在 Webmin發行包基礎上了裁減出了一個 Webmin的核心，最後介紹如何編寫一個 Webmin模塊。
剖析Webmin 的內部結構
解開 Webmin的安裝包，可以發現Webmin 的目錄的組成如下：
一組子目錄，很顯然這些子目錄絕大多數都是一個Webmin 管理模塊，而且可以看出Webmin完全由 perl實現；
一組perl腳本和幾個CGI 腳本，這些腳本可以分為三類：
內置的HTTP伺服器：它支持 CGI，Session 和SSL等功能。Miniserv.pl 和miniserv.pem實現了這個 HTTP伺服器。它的配置文件通常是/etc/webmin/miniserv.conf, 它主要有如下幾個重要參數： 參數及預設值 說明
port=10000 設置 HTTP伺服器監聽的埠
root=/usr/libexec/webmin Web 文件的根目錄
ssl=0 是否支持 SSL,如果設置為1 ，這個HTTP伺服器將提供HTTPS 服務
session=1 是否支持 Session,如果設置為1 ，在訪問Web服務之前必須先完成用戶登錄和認證，用戶的登錄和認證由 session_login.cgi實現
userfile=/etc/webmin/miniserv.users 存放 HTTP伺服器的用戶名和密碼，changepass.pl 可以修改用戶密碼
keyfile=/etc/webmin/minserv.pem 存放 HTTP伺服器的私鑰和公鑰證書
Webmin 核心：這部分包括Webmin核心庫、 Webmin的首頁和模塊管理。Web-lib.pl 是Webmin的核心庫，包含了 Webmin中主要的公用函數。Web-lib.pl 中會引用了一些CGI提供一些公用功能，這些 CGI包括: chooser.cgi 文件選擇 Frame
date_chooser.cgi 日期選擇 Frame
config.cgi 配置模塊配置文件頁面
config_save.cgi 保存配置
help.cgi 幫助頁面
fastrpc.cgi 啟動一個新進程以加快 rpc的調用
rpc.cgi 用於截獲其他 Webmin伺服器發來的Webmin 遠過程調用
referer_save.cgi Redirect 到以前的URL
user_chooser.cgi 用戶選擇 Frame
switch_user.cgi 切換用戶
switch_skill.cgi 改變當前 Webmin用戶的Skill level
acl_security.cgi 配置全局 ACL選項
index.cgi 實現Webmin的首頁，它將當前用戶可以使用的管理模塊按類別分為一個屬性頁顯示。
Install-Module.pl 用於從命令行安裝一個Webmin的管理模塊。它調用了 copyconfig.pl和perlpath.pl 。
安裝腳本：這些腳本用於安裝配置Webmin 。Setup.pl是主要的配置腳本，它調用如下腳本：腳本 說明
newmods.pl 用於初始化一個新插入模塊的配置文件
oschooser.pl 選擇操作系統類型
copyconfig.pl 給管理模塊複製配置文件
thirdparty.pl 檢查已經安裝的模塊
perlpath.pl 當 perl的路徑不是/usr/local/bin/perl 時，替換perl腳本中的#!/usr/local/bin/perl
裁減出Webmin 的核心
Webmin的開發目的是建立一個 Web界面的UNIX 系統管理工具，所以Webmin的發行版中不僅包含了 Webmin的工作核心，而且包含了大量的管理模塊。而實際上裁減出一個 Webmin的核心也是件很有意義的事情，這主要體現在下面兩個方面：
一般Webmin的自帶的管理模塊並不需要同時存在，能夠需要什麼模塊時插入才是比較理想的做法
Webmin 核心為我們提供了一個支持認證和訪問控制的Web 伺服器和一套有效合理的開發小型Web應用的程序框架。
基於以上原因，筆者裁減出了一個 Webmin的核心並命名為webmin-platform 。和Webmin的發行版相比， Webmin-Platform具有如下特點：
短小精湛，webmin-platform的安裝包只有 100多K, 預設只包括Webmin配置和用戶管理兩個模塊。 Webmin的其他模塊可以順利加入。
預設情況下把Webmin的配置文件和 log文件都設置在安裝目錄，減少了對UNIX 系統的依賴性。
讓筆者比較遺憾的是，目前 Webmin不支持Win32 平台，因此webmin-platform也不支持 Win32平台。有興趣的讀者，可以嘗試把webmin-platform 移植到Windows平台。
Webmin模塊
Webmin模塊實際上是一個壓縮過的 TAR包，你可以通過tar zxvf 命令解開任何一個Webmin模塊包。一般 Webmin模塊的結構如下所示： 目錄或文件 說明
index.cgi 該模塊的首頁
config 預設的配置文件
config.info 對配置文件中配置選項的說明
module.info 對模塊的說明，包括模塊名 (name)、模塊描述(desc) 、類別(category)、依賴 (dependency)和模塊版本（version ）。
acl_security.pl 模塊的訪問控制
image/ 存放模塊中用到的圖片
lange/ 存放頁面信息中的各種語言版本
Webmin模塊中的 CGI腳本一般都具有相似的結構，下面將通過 Webmin技術文檔中模板文件為例來說明這種結構：
#!/usr/bin/perl
#這是Webmin模塊的一個模板
do '../web-lib.pl';
&init_config();
%access=&get_module_acl;
&ReadParse();
##檢查訪問控制(ACL)
##頁眉
&header($text{'index_title'}, "", "intro", 1, 1, undef,
"Written by
AuthorHome://page");
##在這插入你的代碼
##輸出一個表格
print "",
"$text{'title'}\n",
"$text{'prject1'}\n",
"";
##頁腳
&footer("/", $text{'index'});
##模塊中的子函數放在這裡
### END of index.cgi ###.
這個模板文件結構很清晰，它依次由下面幾部分組成：
Webmin 中的腳本文件必須包含Webmin根目錄下的 web-lib.pl。web-lib.pl 是Webmin提供的支持庫，所有的 Webmin的API 函數都在這個文件中定義。
模板文件首先調用init_config獲取本模塊的配置選項
接著需要調用get_module_acl獲取訪問控制表
調用ReadParse函數將 HTTP請求的參數編譯到關聯數組%in 中
下面就可以檢查當前用戶是否具有訪問這個頁面的許可權了
以上是初始化工作，下面可以輸出頁面了。函數header 由Webmin提供，它列印出一個標準的 Webmin頁眉
在輸出你自己的頁面內容后，可以調用footer 函數列印出Webmin標準的頁腳。
下面幾小節闡述編寫Webmin模塊涉及的幾個主要問題。
這個模板文件結構很清晰，它依次由下面幾部分組成：
Webmin 中的腳本文件必須包含Webmin根目錄下的 web-lib.pl。web-lib.pl 是Webmin提供的支持庫，所有的 Webmin的API 函數都在這個文件中定義。
模板文件首先調用init_config獲取本模塊的配置選項
接著需要調用get_module_acl獲取訪問控制表
調用ReadParse函數將 HTTP請求的參數編譯到關聯數組%in 中
下面就可以檢查當前用戶是否具有訪問這個頁面的許可權了
以上是初始化工作，下面可以輸出頁面了。函數header 由Webmin提供，它列印出一個標準的 Webmin頁眉
在輸出你自己的頁面內容后，可以調用footer 函數列印出Webmin標準的頁腳。
下面幾小節闡述編寫Webmin模塊涉及的幾個主要問題。
統一的界面風格
Webmin要求形形色色的模塊具有相同的界面風格和統一的色彩方案。為了達到這種效果，所有模塊應該遵循如下規則：
所有支持image、table 和form的瀏覽器都能夠正確顯示管理頁面。應該盡量避免使用 frame、DHTML 、JavaScript和Java 等和瀏覽器相關的特徵；
所有產生HTML頁面的CGI 程序都應該調有header生成頁頭。它會生成一個顯示頁面主題的圖片，還可能會加入一些主要的連接。所有這些 CGI都應該保持字體類型、大小和風格的一致性；
應該使用$tb作為表格頭的背景色，使用 $cb作為表格體的背景色。就像模板文件中的輸出表格語句那樣；
應該避免在Form中包含大量的輸入控制項，一些 UNIX的瀏覽器處理這樣的Form 時會比較慢；
國際化支持
Webmin提供國際化支持。任何希望支持國際化的模塊都應該包含子目錄 lang。lang 目錄中包含不同國家語言的系統消息翻譯文件。這個文件中每一行包含一個消息的定義：
message_code=Message in this language
Webmin 根目錄下的lang_list.txt包含了現在支持的語言和支持的編碼格式。因為Webmin 的預設語言是英語，所以消息翻譯文件lang/en很特殊。當找不到某消息的某語言版本時會用它的英語版本代替。簡體中文的翻譯文件是 lang/zh_CN。
當使用在頁面中使用國際化的消息時應該使用 Wembin定義的關聯數組$text。如當前 Webmin使用簡體中文，某模塊的簡體中文消息文件中包括：
index_title=我喜歡Webmin
那麼 CGI程序中
print $text{" index_title" };
的輸出是：
我喜歡Webmin
模塊的配置
Webmin中的配置參數分為全局參數和模塊參數。全局配置參數預設放在 /etc/webmin/config中，模塊配置參數預設放在 /etc/webmin/$MODULENAME/config 中。在CGI中調用init_config 函數可以全局配置參數讀入到關聯數組%gconfig ，把模塊配置參數讀入到關聯數組%config 中。
一個完整的模塊應該具有 config.info文件，它定義了模塊配置參數的信息。 Webmin根目錄下的config.cgi 使用這個文件產生修改模塊配置參數的頁面。config.info 中每一行說明一個參數的信息：
config_name=description,type[,values]
config_name 定義了配置參數的描述，description 定義配置參數的說明，type定義配置參數值的類型， values定義配置參數的預設值。
同一個模塊可能在不同的 UNIX系統中具有不同的預設配置。所以完整的模塊還應該包含不同操作系統的預設配置文件。這些配置文件的命名規則是：
config-osname-osversion
config-osname
config
Webmin目錄下的 os_list.txt列出了當前Webmin 支持的UNIX系統
訪問控制
Webmin支持基於模塊的用戶訪問控制。 /etc/webmin/webmin.acl文件定義了 webmin用戶可以訪問的模塊。如果想實現更小粒度的訪問控制，可以使用 Webmin提供的基於模塊操作的用戶訪問控制。在模塊的配置目錄下， Webmin會為每個用戶生成一個訪問控制文件，它通常被命名為 $username.acl (如root.acl) 。模塊可以編寫acl_security.pl 來操作這個文件。Webmin要求 acl_security.pl定義兩個函數操作模塊訪問控制文件：
acl_security_form(acl) ：該函數輸出一個HTML的表格項。這個函數的輸出提供給管理員修改某個用戶對模塊某個操作的訪問許可權。
acl_security_save(acl,input) ：這個函數可以在保存管理員對訪問許可權修改前做些必要的操作。
如果沒有 acl_security.pl，Webmin 會提供一個預設的訪問控制參數isconfig ，它指定一個用戶是否擁有修改模塊配置參數的許可權。
如模板文件所示， CGI程序調用get_module_acl 把當前用戶的訪問許可權讀入一個關聯數組。下面是在程序檢測用戶訪問許可權的例子：
#!/usr/local/bin/perl
require './foo-lib.pl';
%access = &get_module_acl();
$access{'create'} || &error("You are not allowed to create new foo users");
其他問題
前幾節闡述了編寫 Webmin模塊需要涉及的幾個常見問題。下面是一些沒有涉及到的問題：
文件加鎖
活動日誌
在線幫助
用戶更新通知
界面主題
關於這些問題，請參閱 Webmin模塊編寫幫助。
常用函數
最後簡單的列舉編寫 Webmin模塊經常用到的函數和全局變數：
ReadParseMime：編譯具有MIME 參數的HTTP請求參數
file_chooser_button：返回一個 JavaScript按鈕，它允許用戶選擇一個 Webmin伺服器上的一個文件
user_chooser_button：返回一個 JavaScript按鈕，它允許用戶選擇一個 Webmin伺服器上的系統用戶
group_chooser_button：返回一個 JavaScript按鈕，它允許用戶選擇一個 Webmin伺服器上的用戶組
$module_name：當前模塊的名稱
$module_config_directory：當前模塊的配置文件目錄
結語
可插入模塊機製為 Webmin帶來了極大的可擴展性，也使得用戶可以方便的定製自己的管理模塊。同時利用 Webmin平台構造一些小型的Web 應用也是個不錯的選擇。
參考資料
從http://www.webmin.com/webmin/download.html 下載最新版Webmin
從http://webmin.thirdpartymodules.com/ 下載第三方Webmin的管理模塊
從http://www.webmin.com/webmin/index2.html 獲取Webmin用戶手冊
從http://www.webmin.com/webmin/index3.html 獲取Webmin的技術文檔
在http://www.sourceforge.net 上查找第三方Webmin 的管理模塊
筆者裁減的Webmin核心 webmin-platform-0.91.tgz
關於作者
金戈，IBM中國開發實驗室軟體工程師，2001年獲中科院計算機科學碩士學位。主要研究方向是Linux、Java、軟體工程和中間件技術。曾在《軟體學報》等國家核心刊物上發表多篇論文，並主持開發過多個Linux和Java項目.
