我們通過Shell可以實現(xiàn)簡單的控制流功能,如:循環(huán)、判斷等。但是對于需要交互的場合則必須通過人工來干預,有時候我們可能會需要實現(xiàn)和交互程序如telnet服務器等進行交互的功能。而Expect就使用來實現(xiàn)這種功能的工具。
Expect是一個免費的編程工具語言,用來實現(xiàn)自動和交互式任務進行通信,而無需人的干預。Expect的作者DonLibes在1990年開始編寫Expect時對Expect做有如下定義:Expect是一個用來實現(xiàn)自動交互功能的軟件套件(Expect [isa] software suite for automating interactivetools)。使用它系統(tǒng)管理員的可以創(chuàng)建腳本用來實現(xiàn)對命令或程序提供輸入,而這些命令和程序是期望從終端(terminal)得到輸入,一般來說這些輸入都需要手工輸入進行的。Expect則可以根據(jù)程序的提示模擬標準輸入提供給程序需要的輸入來實現(xiàn)交互程序執(zhí)行。甚至可以實現(xiàn)實現(xiàn)簡單的BBS聊天機器人。 :)
Expect是不斷發(fā)展的,隨著時間的流逝,其功能越來越強大,已經(jīng)成為系統(tǒng)管理員的的一個強大助手。Expect需要Tcl編程語言的支持,要在系統(tǒng)上運行Expect必須首先安裝Tcl。
Expect工作原理
從最簡單的層次來說,Expect的工作方式象一個通用化的Chat腳本工具。Chat腳本最早用于UUCP網(wǎng)絡內(nèi),以用來實現(xiàn)計算機之間需要建立連接時進行特定的登錄會話的自動化。
Chat腳本由一系列expect-send對組成:expect等待輸出中輸出特定的字符,通常是一個提示符,然后發(fā)送特定的響應。例如下面的Chat腳本實現(xiàn)等待標準輸出出現(xiàn)Login:字符串,然后發(fā)送somebody作為用戶名;然后等待Password:提示符,并發(fā)出響應sillyme。
Login: somebody Password: sillyme
這個腳本用來實現(xiàn)一個登錄過程,并用特定的用戶名和密碼實現(xiàn)登錄。
Expect最簡單的腳本操作模式本質(zhì)上和Chat腳本工作模式是一樣的。下面我們分析一個響應chsh命令的腳本。我們首先回顧一下這個交互命令的格式。假設我們?yōu)橛脩鬰havez改變登錄腳本,命令交互過程如下:
# chsh chavez
Changing the login shell for chavez
Enter the new value, or press return for the default
Login Shell [/bin/bash]: /bin/tcsh
#
可以看到該命令首先輸出若干行提示信息并且提示輸入用戶新的登錄shell。我們必須在提示信息后面輸入用戶的登錄shell或者直接回車不修改登錄shell。
下面是一個能用來實現(xiàn)自動執(zhí)行該命令的Expect腳本:
#!/usr/bin/expect
# Change a login shell to tcsh
set user [lindex $argv 0]
spawn chsh $user
expect "]:"
send "/bin/tcsh "
expect eof
exit
這個簡單的腳本可以解釋很多Expect程序的特性。和其他腳本一樣首行指定用來執(zhí)行該腳本的命令程序,這里是/usr/bin/expect。程序第一行用來獲得腳本的執(zhí)行參數(shù)(其保存在數(shù)組$argv中,從0號開始是參數(shù)),并將其保存到變量user中。
第二個參數(shù)使用Expect的spawn命令來啟動腳本和命令的會話,這里啟動的是chsh命令,實際上命令是以衍生子進程的方式來運行的。
隨后的expect和send命令用來實現(xiàn)交互過程。腳本首先等待輸出中出現(xiàn)]:字符串,一旦在輸出中出現(xiàn)chsh輸出到的特征字符串(一般特征字符串往往是等待輸入的最后的提示符的特征信息)。對于其他不匹配的信息則會完全忽略。當腳本得到特征字符串時,expect將發(fā)送/bin/tcsh和一個回車符給chsh命令。最后腳本等待命令退出(chsh結(jié)束),一旦接收到標識子進程已經(jīng)結(jié)束的eof字符,expect腳本也就退出結(jié)束。
決定如何響應
管理員往往有這樣的需求,希望根據(jù)當前的具體情況來以不同的方式對一個命令進行響應。我們可以通過后面的例子看到expect可以實現(xiàn)非常復雜的條件響應,而僅僅通過簡單的修改預處理腳本就可以實現(xiàn)。下面的例子是一個更復雜的expect-send例子:
expect -re "\[(.*)]:"
if {$expect_out(1,string)!="/bin/tcsh"} {
send "/bin/tcsh" }
send " "
expect eof
在這個例子中,第一個expect命令現(xiàn)在使用了-re參數(shù),這個參數(shù)表示指定的的字符串是一個正則表達式,而不是一個普通的字符串。對于上面這個例子里是查找一個左方括號字符(其必須進行三次逃逸(escape),因此有三個符號,因為它對于expect和正則表達時來說都是特殊字符)后面跟有零個或多個字符,最后是一個右方括號字符。這里.*表示表示一個或多個任意字符,將其存放在()中是因為將匹配結(jié)果存放在一個變量中以實現(xiàn)隨后的對匹配結(jié)果的訪問。
當發(fā)現(xiàn)一個匹配則檢查包含在[]中的字符串,查看是否為/bin/tcsh。如果不是則發(fā)送/bin/tcsh給chsh命令作為輸入,如果是則僅僅發(fā)送一個回車符。這個簡單的針對具體情況發(fā)出不同相響應的小例子說明了expect的強大功能。
在一個正則表達時中,可以在()中包含若干個部分并通過expect_out數(shù)組訪問它們。各個部分在表達式中從左到右進行編碼,從1開始(0包含有整個匹配輸出)。()可能會出現(xiàn)嵌套情況,這這種情況下編碼從最內(nèi)層到最外層來進行的。
使用超時
下一個expect例子中將闡述具有超時功能的提示符函數(shù)。這個腳本提示用戶輸入,如果在給定的時間內(nèi)沒有輸入,則會超時并返回一個默認的響應。這個腳本接收三個參數(shù):提示符字串,默認響應和超時時間(秒)。
#!/usr/bin/expect
# Prompt function with timeout and default.
set prompt [lindex $argv 0]
set def [lindex $argv 1]
set response $def
set tout [lindex $argv 2]
腳本的第一部分首先是得到運行參數(shù)并將其保存到內(nèi)部變量中。
send_tty "$prompt: "
set timeout $tout
expect " " {
set raw $expect_out(buffer)
# remove final carriage return
set response [string trimright "$raw" " "]
}
if {"$response" == "} {set response $def}
send "$response "
# Prompt function with timeout and default.
set prompt [lindex $argv 0]
set def [lindex $argv 1]
set response $def
set tout [lindex $argv 2]
這是腳本其余的內(nèi)容??梢钥吹絪end_tty命令用來實現(xiàn)在終端上顯示提示符字串和一個冒號及空格。set timeout命令設置后面所有的expect命令的等待響應的超時時間為$tout(-l參數(shù)用來關閉任何超時設置)。
然后expect命令就等待輸出中出現(xiàn)回車字符。如果在超時之前得到回車符,那么set命令就會將用戶輸入的內(nèi)容賦值給變臉raw。隨后的命令將用戶輸入內(nèi)容最后的回車符號去除以后賦值給變量response。
然后,如果response中內(nèi)容為空則將response值置為默認值(如果用戶在超時以后沒有輸入或者用戶僅僅輸入了回車符)。最后send命令將response變量的值加上回車符發(fā)送給標準輸出。
一個有趣的事情是該腳本沒有使用spawn命令。 該expect腳本會與任何調(diào)用該腳本的進程交互。
如果該腳本名為prompt,那么它可以用在任何C風格的shell中。
% set a='prompt "Enter an answer" silence 10'
Enter an answer: test
% echo Answer was "$a"
Answer was test
prompt設定的超時為10秒。如果超時或者用戶僅僅輸入了回車符號,echo命令將輸出
Answer was "silence"
一個更復雜的例子
下面我們將討論一個更加復雜的expect腳本例子,這個腳本使用了一些更復雜的控制結(jié)構(gòu)和很多復雜的交互過程。這個例子用來實現(xiàn)發(fā)送write命令給任意的用戶,發(fā)送的消息來自于一個文件或者來自于鍵盤輸入。
#!/usr/bin/expect
# Write to multiple users from a prepared file
# or a message input interactively
if {$argc<2} {
send_user "usage: $argv0 file user1 user2 ... "
exit
}
send_user命令用來顯示使用幫助信息到父進程(一般為用戶的shell)的標準輸出。
set nofile 0
# get filename via the Tcl lindex function
set file [lindex $argv 0]
if {$file=="i"} {
set nofile 1
} else {
# make sure message file exists
if {[file isfile $file]!=1} {
send_user "$argv0: file $file not found. "
exit }}
這部分實現(xiàn)處理腳本啟動參數(shù),其必須是一個儲存要發(fā)送的消息的文件名或表示使用交互輸入得到發(fā)送消的內(nèi)容的"i"命令。
變量file被設置為腳本的第一個參數(shù)的值,是通過一個Tcl函數(shù)lindex來實現(xiàn)的,該函數(shù)從列表/數(shù)組得到一個特定的元素。[]用來實現(xiàn)將函數(shù)lindex的返回值作為set命令的參數(shù)。
如果腳本的第一個參數(shù)是小寫的"i",那么變量nofile被設置為1,否則通過調(diào)用Tcl的函數(shù)isfile來驗證參數(shù)指定的文件存在,如果不存在就報錯退出。
可以看到這里使用了if命令來實現(xiàn)邏輯判斷功能。該命令后面直接跟判斷條件,并且執(zhí)行在判斷條件后的{}內(nèi)的命令。if條件為false時則運行else后的程序塊。
set procs {}
# start write processes
for {set i 1} {$i<$argc}
{incr i} {
spawn -noecho write
[lindex $argv $i]
lappend procs $spawn_id
}
最后一部分使用spawn命令來啟動write進程實現(xiàn)向用戶發(fā)送消息。這里使用了for命令來實現(xiàn)循環(huán)控制功能,循環(huán)變量首先設置為1,然后因此遞增。循環(huán)體是最后的{}的內(nèi)容。這里我們是用腳本的第二個和隨后的參數(shù)來spawn一個write命令,并將每個參數(shù)作為發(fā)送消息的用戶名。lappend命令使用保存每個spawn的進程的進程ID號的內(nèi)部變量$spawn_id在變量procs中構(gòu)造了一個進程ID號列表。
if {$nofile==0} {
setmesg [open "$file" "r"]
} else {
send_user "enter message,
ending with ^D: " }
最后腳本根據(jù)變量nofile的值實現(xiàn)打開消息文件或者提示用戶輸入要發(fā)送的消息。
set timeout -1
while 1 {
if {$nofile==0} {
if {[gets $mesg chars] == -1} break
set line "$chars "
} else {
expect_user {
-re " " {}
eof break }
set line $expect_out(buffer) }
foreach spawn_id $procs {
send $line }
sleep 1}
exit
上面這段代碼說明了實際的消息文本是如何通過無限循環(huán)while被發(fā)送的。while循環(huán)中的 if判斷消息是如何得到的。在非交互模式下,下一行內(nèi)容從消息文件中讀出,當文件內(nèi)容結(jié)束時while循環(huán)也就結(jié)束了。(break命令實現(xiàn)終止循環(huán)) 。
在交互模式下,expect_user命令從用戶接收消息,當用戶輸入ctrl+D時結(jié)束輸入,循環(huán)同時結(jié)束。 兩種情況下變量$line都被用來保存下一行消息內(nèi)容。當是消息文件時,回車會被附加到消息的尾部。
foreach循環(huán)遍歷spawn的所有進程,這些進程的ID號都保存在列表變量$procs中,實現(xiàn)分別和各個進程通信。send命令組成了foreach的循環(huán)體,發(fā)送一行消息到當前的write進程。while循環(huán)的最后是一個sleep命令,主要是用于處理非交互模式情況下,以確保消息不會太快的發(fā)送給各個write進程。當while循環(huán)退出時,expect腳本結(jié)束。
參考資源
Expect軟件版本深帶有很多例子腳本,不但可以用于學習和理解expect腳本,而且是非常使用的工具。一般可以在/usr/doc/packages/expect/example看到它們,在某些linux發(fā)布中有些expect腳本保存在/usr/bin目錄下。
Don Libes, Exploring Expect, O'Reilly & Associates, 1995.
John Ousterhout, Tcl and the Tk Toolkit, Addison-Wesley, 1994.
一些有用的expect腳本
autoexpect:這個腳本將根據(jù)自身在運行時用戶的操作而生成一個expect腳本。它的功能某種程度上類似于在Emacs編輯器的鍵盤宏工具。一個自動創(chuàng)建的腳本可能是創(chuàng)建自己定制腳本的好的開始。
kibitz:這是一個非常有用的工具。通過它兩個或更多的用戶可以連接到同一個shell進程??梢杂糜诩夹g支持或者培訓(參見下圖)。
同樣可以用于其他一些要求同步的協(xié)同任務。例如我希望和另外一個同事一起編輯一封信件,這樣通過kibitz我們可以共享同一個運行編輯器的腳本,同時進行編輯和查看信件內(nèi)容。
tkpasswd: 這個腳本提供了修改用戶密碼的GUI工具,包括可以檢查密碼是否是基于字典模式。這個工具同時是一個學習expect和tk的好實例。