在 Web 應(yīng)用程序中運(yùn)行 shell 命令
學(xué)習(xí)如何更好地集成腳本和命令行工具。本文考察如何使用shell_exec()、exec()、passthru() 和 system();安全地將信息傳遞到命令行;以及安全地從命令行獲取信息。
如果您使用過 PHP,您就會(huì)發(fā)現(xiàn)它是創(chuàng)建特性豐富的 Web 頁面的出色工具。
作為一大腳本語言,PHP:
- 容易學(xué)習(xí)。
- 有許多強(qiáng)大的框架(比如 CakePHP 和 CodeIgniter),讓您能夠像 Rails 程序員一樣高效。
- 能夠與 MySQL、PostgreSQL、Microsoft® SQL Server,甚至 Oracle 通信。
- 能夠輕松地與 JavaScript 框架集成,比如 script.aculo.us 和 jQuery。
但有時(shí)候,您想做更多的事情,或必須做更多的事情。我的意思是您必須直接與 PHP 運(yùn)行的服務(wù)器的文件系統(tǒng)打交道。您最終需要處理文件系統(tǒng)上的文件,了解運(yùn)行的進(jìn)程或執(zhí)行其他任務(wù)。
首先,您對(duì)在 PHP 使用 file() 命令打開文件很滿意。但是在某種程度上,完成某些事情的唯一途徑是在服務(wù)器上運(yùn)行 shell 命令并獲得特定的輸出。例如,您可能想知道特定目錄包含多少個(gè)文件?;蛘吣胫老蚰辰M日志文件寫了多少行內(nèi)容?;蛘吣氩僮鬟@些文件,將它們復(fù)制到另一個(gè)目錄,或使用 rsync 將它們發(fā)送到另一個(gè)位置。
僅當(dāng)您運(yùn)行在 Linux®、Berkeley Software Distribution (BSD) 或一些其他 UNIX® 版本上時(shí),這些操作才有效。我假設(shè)您運(yùn)行在 Linux-Apache-MySQL-PHP (LAMP) 堆棧上。如果您運(yùn)行其他版本的 UNIX,具體細(xì)節(jié)可能不同,因?yàn)樵诿總€(gè)版本中命令行的可用性都不同。我知道很多人還在 Mac OS X(運(yùn)行某個(gè)版本的 BSD)從事開發(fā),因此我盡量保持示例命令的通用性,確保移植方便。
命令行概述
PHP Command Line Interface (CLI) Server Application Programming Interface (SAPI) 在 PHP V4.2.0 開始發(fā)布,用于試驗(yàn)?zāi)康?。?V4.3.0 時(shí),已經(jīng)受到完整支持并且默認(rèn)啟用。PHP CLI SAPI 允許您開發(fā) PHP 支持的 shell 腳本,甚至是基于桌面的腳本。事實(shí)上,可以用 PHP 創(chuàng)建可直接從命令行運(yùn)行的工具。采用這種方式,PHP 開發(fā)人員可以像 Perl、AWK、Ruby 或 shell 程序員一樣高效。
本文探究構(gòu)建到 PHP 中的工具,讓您了解 PHP 運(yùn)行的底層 shell 環(huán)境和文件系統(tǒng)。PHP 為執(zhí)行外部命令提供大量函數(shù),其中包括shell_exec()、exec()、passthru() 和 system()。這些命令是相似的,但為您運(yùn)行的外部程序提供不同的界面。所有這些命令都衍生一個(gè)子進(jìn)程,用于運(yùn)行您指定的命令或腳本,并且每個(gè)子進(jìn)程會(huì)在命令輸出寫到標(biāo)準(zhǔn)輸出 (stdout) 時(shí)捕捉它們。
shell_exec()
shell_exec() 命令行實(shí)際上僅是反撇號(hào) (`) 操作符的變體。如果您編寫過 shell 或 Perl 腳本,您就知道可以在反撇號(hào)操作符內(nèi)部捕捉其他命令的輸出。例如,清單 1 顯示了如何使用反撇號(hào)在當(dāng)前目錄中獲取每個(gè)文本(.txt)的單詞計(jì)數(shù)。
清單 1. 使用反撇號(hào)計(jì)算單詞數(shù)量
#! /bin/sh number_of_words=`wc -w *.txt` echo $number_of_words #result would be something like: #165 readme.txt 388 results.txt 588 summary.txt #and so on....
在您的 PHP 腳本中,您可以在 shell_exec() 中運(yùn)行這個(gè)簡單的命令,如清單 2 所示,并獲取想要的結(jié)果。這里假設(shè)在同一個(gè)目錄下有一些文本文件。
清單 2. 在 shell_exec() 中運(yùn)行相同的命令
在圖 1 中可以看到,獲得的結(jié)果與從 shell 腳本得到的一樣。這是因?yàn)?nbsp;shell_exec() 允許您通過 shell 運(yùn)行外部程序,然后以字符串的形式返回結(jié)果。
圖 1. 通過 shell_exec() 運(yùn)行 shell 命令的結(jié)果
注意,僅使用后撇號(hào)操作符也會(huì)得到相同的結(jié)果,如下所示。
清單 3. 僅使用后撇號(hào)操作符
清單 4 給出了一種更加簡單的方法。
清單 4. 更加簡單的方法
通過 UNIX 命令行和 shell 腳本能夠完成很多東西,知道這點(diǎn)很重要。例如,您可以使用豎線將命令連接起來。您甚至可以使用操作符在其中創(chuàng)建 shell 腳本,并且僅調(diào)用 shell 腳本(根據(jù)需要使用或不使用參數(shù))。
例如,如果您僅希望計(jì)算該目錄下的前 5 個(gè)文本文件的單詞數(shù),那么可以使用豎線 (|) 將 wc 和 head 命令連接起來。另外,您還可以將輸出結(jié)果放到 pre 標(biāo)記內(nèi)部,讓它能夠更美觀地呈現(xiàn)在 Web 瀏覽器中,如下所示。
清單 5. 更加復(fù)雜的 shell 命令
".$results . ""; ?>
圖 2 演示了運(yùn)行清單 5 的腳本得到的結(jié)果。
圖 2. 從 shell_exec() 運(yùn)行更復(fù)雜的 shell 命令得到的結(jié)果
在本文的后面部分,您將學(xué)習(xí)如何使用 PHP 為這些腳本傳遞參數(shù)?,F(xiàn)在您可以將它看作運(yùn)行 shell 命令的一種方法,但要記住您只能看到標(biāo)準(zhǔn)輸出。如果命令或腳本出現(xiàn)錯(cuò)誤,您將看不到標(biāo)準(zhǔn)的錯(cuò)誤 (stderr),除非您通過豎線將它添加到 stdout。
passthru()
passthru() 允許您運(yùn)行外部程序,并在屏幕上顯示結(jié)果。您不需要使用 echo 或 return 來查看結(jié)果;它們會(huì)顯示在瀏覽器上。您可以添加可選的參數(shù),即保存從外部程序返回的代碼的變量,比如表示成功的 0,這為調(diào)試提供更好的機(jī)制。
在清單 6 中,我使用 passthru() 命令運(yùn)行在前面小節(jié)運(yùn)行的單詞計(jì)數(shù)腳本。如您所見,我還添加一個(gè)包含返回代碼的 $returnval 變量。
清單 6. 使用 passthru() 命令運(yùn)行單詞計(jì)數(shù)腳本
".$returnval; ?>
注意,我不需要使用 echo 返回任何東西。結(jié)果會(huì)直接顯示在屏幕上,如下所示。
圖 3. 使用 return 代碼運(yùn)行 passthru() 命令的結(jié)果
在清單 7 中,我通過刪除腳本頭部的 5 前面的短橫線 (-) 引入一個(gè)小錯(cuò)誤。
清單 7. 在單詞計(jì)數(shù)腳本中引入一個(gè)錯(cuò)誤
".$returnval; ?>
注意,腳本未能按照預(yù)期運(yùn)行。您得到的是一個(gè)空白的屏幕,一條水平線和返回值 1,如圖 4 所示。這個(gè)返回代碼通常表明發(fā)生了某些錯(cuò)誤。如果能夠測試返回代碼,查找和修復(fù)錯(cuò)誤就容易多了。
圖 4. 使用 passthru() 時(shí)查看錯(cuò)誤代碼
exec()
exec() 命令與 shell_exec() 相似,不同之處是它返回輸出的最后一行,并且可選地用命令的完整輸出和錯(cuò)誤代碼填充數(shù)組。清單 8 展示了當(dāng)運(yùn)行 exec() 而不捕捉數(shù)據(jù)數(shù)組中的數(shù)據(jù)時(shí)發(fā)生的事情。
清單 8. 運(yùn)行 exec() 而不捕捉數(shù)據(jù)數(shù)組中的數(shù)據(jù)
為了捕捉數(shù)組中的結(jié)果,要將該數(shù)組的名稱作為第二個(gè)參數(shù)添加到 exec()。我在清單 9 中執(zhí)行了這個(gè)步驟,并以 $data 作為數(shù)組的名稱。
清單 9. 從 exec() 捕捉數(shù)據(jù)數(shù)組的結(jié)果
555 text1.txt [1] => 283 text2.txt) ?>
在捕捉數(shù)組中的結(jié)果之后,您可以對(duì)每行進(jìn)行一些處理。例如,您可以在第一個(gè)空格處進(jìn)行劃分,將分離的值存儲(chǔ)在數(shù)據(jù)庫表中,或?qū)γ總€(gè)行應(yīng)用特定的格式或標(biāo)記。
system()
如清單 10 所示,system() 命令是一種混合體。它像 passthru() 一樣直接輸出從外部程序接收到的任何東西。它還像 exec() 一樣返回最后一行,并使返回代碼可用。
清單 10. system() 命令
一些例子
現(xiàn)在您已經(jīng)了解如何使用這些 PHP 命令,但可能仍然有一些疑問。例如,什么時(shí)候應(yīng)該使用哪個(gè)命令?這完全由您的需求決定。
大多數(shù)情況下,我使用 exec() 命令和數(shù)據(jù)數(shù)組處理所有東西?;蛘邔?duì)更簡單的命令使用 shell_exec(),尤其是不關(guān)心結(jié)果時(shí)。如果僅需返回一個(gè) shell 腳本,我就使用 passthru()。通常,我在不同的場合中使用不同的函數(shù),并且有時(shí)它們是可以互換的。這完全取決于我的心情和要實(shí)現(xiàn)的目的。
您可能提問的另一個(gè)問題是 “它們的長處是什么?”。如果您沒有頭緒,或者一個(gè)項(xiàng)目非常適合使用 shell 命令,但不知道如何使用,那么我在這里提供一些見解。
如果您正在編寫一個(gè)提供各種備份或文件傳輸功能的應(yīng)用程序,您可以選擇使用 shell_exec() 或這里提供的其他命令之一運(yùn)行 rsync 支持的 shell 腳本。您可以編寫 shell 腳本使其包含必要的 rsync 命令,然后使用 passthru() 根據(jù)用戶的命令或 cron 作業(yè)執(zhí)行它。
例如,一位用戶在您的應(yīng)用程序中有適當(dāng)?shù)臋?quán)限(比如管理員權(quán)限),他想將 50 個(gè) PDF 文件從一個(gè)服務(wù)器發(fā)送到另一個(gè)服務(wù)器。那么,該用戶需要在應(yīng)用程序中導(dǎo)航到正確的位置,單擊 Transfer,選擇需要發(fā)送的 PDF,然后單擊 Submit。在這個(gè)過程中,該表單應(yīng)該有一個(gè) PHP 腳本,它使用返回選項(xiàng)變量通過 passthru() 運(yùn)行 rsync 腳本,這樣您就知道是否發(fā)生問題,如下所示。
清單 11. 通過 passthru() 運(yùn)行 rsync 腳本的示例 PHP 腳本
如果您的應(yīng)用程序需要列出進(jìn)程或文件,或關(guān)于這些進(jìn)程或文件的數(shù)據(jù),您可以使用本文總結(jié)的命令之一輕松實(shí)現(xiàn)這個(gè)目的。例如,一個(gè)簡單的 grep 命令能夠幫助您找到匹配特定搜索條件的文件。將它與 exec() 命令一起使用可以將結(jié)果保存到一個(gè)數(shù)組中,這允許您構(gòu)建一個(gè) HTML 表或表單,它們又進(jìn)一步允許您運(yùn)行其他命令。
到目前為止,我討論了用戶生成的事件 —— 用戶只要按下按鈕或單擊鏈接,PHP 就運(yùn)行相應(yīng)的腳本。您還可以將獨(dú)立的 PHP 腳本和 cron 或其他日程安排程序一起使用,從而實(shí)現(xiàn)一些有趣的效果。例如,如果您一個(gè)備份腳本,您可以通過 cron 運(yùn)行它,或者將它打包到 PHP 腳本后在運(yùn)行。為什么要這樣做?這似乎是多余的,不是嗎?不是這樣的 —— 您需要這樣考慮,您可以通過 exec() 或 passthru() 運(yùn)行備份腳本,然后根據(jù)返回代碼執(zhí)行一些行為。如果出現(xiàn)錯(cuò)誤,您可以將其記錄到錯(cuò)誤日志或數(shù)據(jù)庫中,或發(fā)送一封警告電子郵件。如果腳本成功,您可以將原始的輸出轉(zhuǎn)儲(chǔ)到數(shù)據(jù)庫(例如,rsync 有一個(gè)詳盡(verbose)模式,對(duì)隨后診斷問題十分有用)。
安全
我們?cè)谶@里簡要討論一下安全性:如果您接受用戶輸入并將信息傳遞到 shell,那么最好過濾用戶輸入。刪除您認(rèn)為有害的命令和不允許的內(nèi)容,比如 sudo(作為超級(jí)用戶運(yùn)行)或 rm(刪除)。事實(shí)上,您可能不希望用戶發(fā)送開放的請(qǐng)求,而是讓他們從列表中選擇。
例如,您運(yùn)行一個(gè)接受文件列表作為參數(shù)的傳輸程序,您應(yīng)該通過一系列復(fù)選框列出所有文件。用戶可以選擇和取消選擇文件,并通過單擊Submit 激活 rsync shell 腳本。用戶不能自己輸入文件或使用正則表達(dá)式。
在本文中,演示了使用 PHP 命令運(yùn)行 shell 腳本和其他命令的基礎(chǔ)知識(shí)。這些 PHP 命令包括 shell_exec()、exec()、passthru() 和system()?,F(xiàn)在,您應(yīng)該在自己的應(yīng)用程序中實(shí)踐學(xué)到的知識(shí)。