簡介: 學習如何更好地集成腳本和命令行工具。本文考察如何使用 shell_exec()
、exec()
、passthru()
和 system()
;安全地將信息傳遞到命令行;以及安全地從命令行獲取信息。
如果您使用過 PHP,您就會發現它是創建特性豐富的 Web 頁面的出色工具。作為一大腳本語言,PHP:
但有時候,您想做更多的事情,或必須做更多的事情。我的意思是您必須直接與 PHP 運行的服務器的文件系統打交道。您最終需要處理文件系統上的文件,了解運行的進程或執行其他任務。
首先,您對在 PHP 使用 file()
命令打開文件很滿意。但是在某種程度上,完成某些事情的唯一途徑是在服務器上運行 shell 命令並獲得特定的輸出。例如,您可能想知道特定目錄包含多少個文件。或者您想知道向某組日志文件寫了多少行內容。或者您想操作這些文件,將它們復制到另一個目錄,或使用 rsync
將它們發送到另一個位置。
在 “PHP 命令行?是的,您可以!” 這篇文章中,Roger McCoy 演示了如何從命令行直接使用 PHP —— 不需任何 Web 浏覽器。在這篇文章中,我從另一個角度看待相同的主題,向您展示如何緊密地與底層 shell 命令集成,以及將返回值包含到您的界面和進程中。
僅當您運行在 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()
中運行相同的命令
<?php $results = shell_exec('wc -w *.txt'); echo $results; ?>
在圖 1 中可以看到,獲得的結果與從 shell 腳本得到的一樣。這是因為 shell_exec()
允許您通過 shell 運行外部程序,然後以字符串的形式返回結果。
圖 1. 通過 shell_exec()
運行 shell 命令的結果
注意,僅使用後撇號操作符也會得到相同的結果,如下所示。
清單 3. 僅使用後撇號操作符
<?php $results = `wc -w *.txt`; echo $results; ?>
清單 4 給出了一種更加簡單的方法。
清單 4. 更加簡單的方法
<?php echo `wc -w *.txt`; ?>
通過 UNIX 命令行和 shell 腳本能夠完成很多東西,知道這點很重要。例如,您可以使用豎線將命令連接起來。您甚至可以使用操作符在其中創建 shell 腳本,並且僅調用 shell 腳本(根據需要使用或不使用參數)。
例如,如果您僅希望計算該目錄下的前 5 個文本文件的單詞數,那麼可以使用豎線 (|
) 將 wc
和 head
命令連接起來。另外,您還可以將輸出結果放到 pre
標記內部,讓它能夠更美觀地呈現在 Web 浏覽器中,如下所示。
清單 5. 更加復雜的 shell 命令
<?php $results = shell_exec('wc -w *.txt | head -5'); echo "<pre>".$results . "</pre>"; ?>
圖 2 演示了運行清單 5 的腳本得到的結果。
圖 2. 從 shell_exec()
運行更復雜的 shell 命令得到的結果
在本文的後面部分,您將學習如何使用 PHP 為這些腳本傳遞參數。現在您可以將它看作運行 shell 命令的一種方法,但要記住您只能看到標准輸出。如果命令或腳本出現錯誤,您將看不到標准的錯誤 (stderr
),除非您通過豎線將它添加到 stdout
。
passthru()
passthru()
允許您運行外部程序,並在屏幕上顯示結果。您不需要使用 echo
或 return
來查看結果;它們會顯示在浏覽器上。您可以添加可選的參數,即保存從外部程序返回的代碼的變量,比如表示成功的 0,這為調試提供更好的機制。
在清單 6 中,我使用 passthru()
命令運行在前面小節運行的單詞計數腳本。如您所見,我還添加一個包含返回代碼的 $returnval
變量。
清單 6. 使用 passthru()
命令運行單詞計數腳本
<?php passthru('wc -w *.txt | head -5',$returnval); echo "<hr/>".$returnval; ?>
注意,我不需要使用 echo
返回任何東西。結果會直接顯示在屏幕上,如下所示。
圖 3. 使用 return
代碼運行 passthru()
命令的結果
在清單 7 中,我通過刪除腳本頭部的 5 前面的短橫線 (-) 引入一個小錯誤。
清單 7. 在單詞計數腳本中引入一個錯誤
<?php //we introduce an error below (removing - from the head command) passthru('wc -w *.txt | head 5',$returnval); echo "<hr/>".$returnval; ?>
注意,腳本未能按照預期運行。您得到的是一個空白的屏幕,一條水平線和返回值 1,如圖 4 所示。這個返回代碼通常表明發生了某些錯誤。如果能夠測試返回代碼,查找和修復錯誤就容易多了。
圖 4. 使用 passthru()
時查看錯誤代碼
exec()
exec()
命令與 shell_exec()
相似,不同之處是它返回輸出的最後一行,並且可選地用命令的完整輸出和錯誤代碼填充數組。清單 8 展示了當運行 exec()
而不捕捉數據數組中的數據時發生的事情。
清單 8. 運行 exec()
而不捕捉數據數組中的數據
<?php $results = exec('wc -w *.txt | head -5'); echo $results; #would print out just the last line or results, i.e.: #3847 myfile.txt ?>
為了捕捉數組中的結果,要將該數組的名稱作為第二個參數添加到 exec()
。我在清單 9 中執行了這個步驟,並以 $data
作為數組的名稱。
清單 9. 從 exec()
捕捉數據數組的結果
<?php $results = exec('wc -w *.txt | head -5',$data); print_r($data); #would print out the data array: #Array ( [0]=> 555 text1.txt [1] => 283 text2.txt) ?>
在捕捉數組中的結果之後,您可以對每行進行一些處理。例如,您可以在第一個空格處進行劃分,將分離的值存儲在數據庫表中,或對每個行應用特定的格式或標記。
system()
如清單 10 所示,system()
命令是一種混合體。它像 passthru()
一樣直接輸出從外部程序接收到的任何東西。它還像 exec()
一樣返回最後一行,並使返回代碼可用。
清單 10. system()
命令
<?php system('wc -w *.txt | head -5'); #would print out: #123 file1.txt 332 file2.txt 444 file3.txt #and so on ?>