如何 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 以获取更多信息以及如何使用它。