如何 Laravel 中驗證 zip 壓縮包裏的文件?

在 Laravel 程序中上傳文件時,請求驗證可以很好驗證上傳的文件。你可以要求上傳文件必須爲 圖片 , 也可以限制文件字節 大小 , 也可以根據 mime types 或者 文件擴展名 過濾文件。

如果我們希望用戶上載 ZIP 文件,我們可以結合規則並像如下所示的內容使用:

return [
    'file' => 'required|file|mimes:zip|size:3072'
];

但是與圖片、文本或 pdf 文件不同,ZIP 是一個壓縮文件,可以在其中保存多個不同的文件。 假設我們希望用戶上傳一個 ZIP 文件,但帶有特定的必需文件和文件夾結構。 舉一個真實的例子,如果您曾經使用過 Wordpress 並使用 ZIP 文件爲其安裝了主題,則 Wordpress 要求主題 ZIP 文件具有某些特定的文件,例如 style.css 或 post.php。 在 Laravel 中我們如何驗證上傳的 ZIP 文件以查看其是否包含所有必需文件?

 

PHP 的 libzip 擴展

這裏會需要 php 的 libzip 擴展的支持,該擴展的啓用以及具體用法請看文檔 official documentation page.

如何操作 ZIP 文件

第一步,實例化 ZipArchive 類。

$zip = new \ZipArchive();

然後我們就可以通過 open() 方法來解壓 ZIP 文檔了。

$zip->open('/absolute/path/to/file.zip');

方法的官方文檔 指出,如果成功打開 ZIP 文件,它將返回 “true”,否則返回整數錯誤代碼。 我們可以像這樣檢查所有內容:

$zipStatus = $zip->open('/absolute/path/to/file.zip');
if (zipStatus !== true) {
    threw new \Exception('Could not open ZIP file. Error code: ' . zipStatus);
}

// 沒問題,繼續操作…

ZipArchive 類提供了多種方法來幫助我們讀取 ZIP 文件的內容,其中一些方法是

  • count() - 返回 ZIP 文件中的文件數
  • getFromIndex() - 返回指定索引對應的文件
  • getNameIndex() - 返回指定索引的文件名
  • statIndex() - 返回指定索引對應文件的詳細信息(文件名、大小等)

有了這些方法,如果我們想獲得 ZIP 文件中的可用文件列表。 我們可以這樣做:

$filesInside = [];
for ($i = 0; $i < $zip->count(); $i++) {
    array_push($filesInside, $zip->getNameIndex($i));
}

$zip->close();

由於一個 ZipArchive 實例可以同時處理一個 ZIP 文件,因此在處理完該文件後,我們需要使用 close()方法。 當您循環瀏覽多個 ZIP 文件或使用此類創建新的 ZIP 文件時,這一點尤其重要。

 

當你使用 ZipArchive 時有一點需要注意一下, “entity” 的概念,這裏的 “entity” 並不單單是文件,他還包含所有文件夾以及子文件夾。這句話怎麼理解呢?假設我們有個目錄結構如下的文檔:

- invoice.pdf
- profile_picture.jpg
- documents/
  - homework.doc
- bills/
  - january/
    - payment.pdf

我們對當前文檔執行 count() 操作可以得到當前文件數量,雖然我們只有 4 個文件,但 count() 方法返回的是 7 ,這是爲什麼呢?讓我們打印一下 $filesInside 看它裏面到底包含了什麼吧。

$files = [
    'invoice.pdf',
    'profile_picture.jpg',
    'documents/',
    'documents/homework.doc',
    'bills/',
    'bills/january/',
    'bills/january/payment.pdf'
];

可以看到,打印結果中並不僅僅有你的文件還有相應的文件夾。 這裏你還可以通過 getNameIndex() 方法來獲取完整的文件路徑。

集成到 Laravel 程序中

現在,我們知道了如何使用 PHP 獲取 ZIP 的文件列表,讓我們將所有內容集成到 Laravel 中並驗證上傳的 ZIP 文件是否包含必需的文件。

假設我們需要用戶上傳一個 ZIP 文件,並且文件的 assets 目錄中必須包含 thumbnail.jpg 和 style.css 文件。

- thumbnail.jpg
- assets/
  - style.css

這是我們的控制器,該控制器處理帶有名爲 zip_file 的文件上傳:

namespace App\Controllers;
use Illuminate\Http\Request;

class UploadController
{
    const REQUIRED_FILES = [
        'thumbnail.jpg',
        'assets/style.css',
    ];

    public function upload(Request $request)
    {
        $zip = new \ZipArchive();
        $file = $request->file('zip_file');
    }
}

對我們從 Illuminate\Http\Request 中檢索數據時,每個文件都返回一個 Illuminate\Http\UploadedFile 實例。我們可以在實例上使用 path() 方法返回上傳的臨時文件的絕對路徑。

 

這是我們打開 ZIP 文件並使用 ZipArchive 類列出所有文件的方法。

public function upload(Request $request)
{
    $zip = new \ZipArchive();
    $file = $request->file('zip_file');
    $zip->open($file->path());

    $filesInside = [];
    for ($i = 0; $i < $zip->count(); $i++) {
        array_push($filesInside, $zip->getNameIndex($i));
    }
}

現在我們可以使用諸如 array_intersect() 之類的方法將 REQUIRED_FILES 與 $filesInside 進行比對。如果交集元素數量不等於 REQUIRED_FILES 的元素數量,則意味着上傳的 ZIP 文件中並不存在所有必需的文件,因此我們可以中止請求執行或返回驗證錯誤。

 

$intersection = array_intersect(self::REQUIRED_FILES, $filesInside);

if (count($intersection) !== count(self::REQUIRED_FILES)) {
    abort(422);
}

這是我們的控制器,一切就緒:

namespace App\Controllers;
use Illuminate\Http\Request;

class UploadController
{
    const REQUIRED_FILES = [
        'thumbnail.jpg',
        'assets/style.css',
    ];

    public function upload(Request $request)
    {
        $zip = new \ZipArchive();
        $file = $request->file('zip_file');
        $zip->open($file->path());

        $filesInside = [];
        for ($i = 0; $i < $zip->count(); $i++) {
            array_push($filesInside, $zip->getNameIndex($i));
        }

        $intersection = array_intersect(self::REQUIRED_FILES, $filesInside);

        if (count($intersection) !== count(self:: REQUIRED_FILES)) {
            abort(422);
        }

        // ZIP contains all required files, continue
    }
}

最佳實踐

在 Laravel 應用程序中,最佳實踐是將與驗證相關的內容移出控制器。 常見選項有:

出於 ZIP 內容驗證的需要,我創建了一個專用的 Laravel 軟件包,該軟件包幾乎完成了本博客文章中所述的所有操作,並提供了更多選項和功能。 您可以在 GitHub 頁面查看 orkhanahmadov/laravel-zip-validator 以獲取更多信息以及如何使用它。

 


更多學習內容請訪問:

騰訊T3-T4標準精品PHP架構師教程目錄大全,只要你看完保證薪資上升一個臺階(持續更新)

以上內容希望幫助到大家,很多PHPer在進階的時候總會遇到一些問題和瓶頸,業務代碼寫多了沒有方向感,不知道該從那裏入手去提升,對此我整理了一些資料,包括但不限於:分佈式架構、高可擴展、高性能、高併發、服務器性能調優、TP6,laravel,YII2,Redis,Swoole、Swoft、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階乾貨需要的可以免費分享給大家,需要的可以加入我的官方羣點擊此處

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章