欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

如何 Laravel 中验证 zip 压缩包里的文件?

程序员文章站 2022-05-18 09:05:01
在 Laravel 程序中上传文件时,请求验证可以很好验证上传的文件。你可以要求上传文件必须为 图片 , 也可以限制文件字节 大小 , 也可以根据 mime types 或者 文件扩展名 过滤文件。 如果我们希望用户上载 ZIP 文件,我们可以结合规则并像如下所示的内容使用: return [ 'f ......

在 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架构师教程目录大全,只要你看完保证薪资上升一个台阶(持续更新)如何 Laravel 中验证 zip 压缩包里的文件?