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