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

時間 2020-05-08

原文原文鏈接

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

若是咱們但願用戶上載 ZIP 文件，咱們能夠結合規則並像以下所示的內容使用：css

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

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

PHP 的 `libzip` 擴展

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

如何操做 ZIP 文件

第一步，實例化 ZipArchive 類。閉包

$zip = new \ZipArchive();

而後咱們就能夠經過 open() 方法來解壓 ZIP 文檔了。架構

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

方法的官方文檔指出，若是成功打開 ZIP 文件，它將返回「true」，不然返回整數錯誤代碼。咱們能夠像這樣檢查全部內容：ide

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

// 沒問題，繼續操做…

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

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 文件時，這一點尤爲重要。ui

當你使用 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
    }
}