UnzipTest.php

Go to the documentation of this file.

<?php

namespace ILIAS\Filesystem\Util;

use PHPUnit\Framework\Attributes\BackupGlobals;
use PHPUnit\Framework\Attributes\BackupStaticProperties;
use PHPUnit\Framework\Attributes\PreserveGlobalState;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;
use PHPUnit\Framework\Attributes\DataProvider;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\Filesystem\Util\Archive\LegacyArchives;
use ILIAS\Filesystem\Util\Archive\Unzip;
use ILIAS\Filesystem\Util\Archive\UnzipOptions;
use PHPUnit\Framework\TestCase;
use ILIAS\Filesystem\Stream\Stream;

#[BackupGlobals(false)]
#[BackupStaticProperties(false)]
#[PreserveGlobalState(false)]
#[RunTestsInSeparateProcesses]
class UnzipTest extends TestCase
{
    protected string $zips_dir = __DIR__ . '/zips/';
    protected string $unzips_dir = __DIR__ . '/unzips/';

    protected function tearDown(): void
    {
        if (file_exists($this->unzips_dir)) {
            rmdir($this->unzips_dir);
        }
    }

    #[DataProvider('getZips')]
    public function testUnzip(
        string $zip,
        bool $has_multiple_root_entries,
        int $expected_amount_directories,
        array $expected_directories,
        int $expected_amount_files,
        array $expected_files
    ): void {
        $this->assertStringContainsString('.zip', $zip);
        $zip_path = $this->zips_dir . $zip;
        $this->assertFileExists($zip_path);

        $stream = Streams::ofResource(fopen($zip_path, 'rb'));
        $options = new UnzipOptions();
        $unzip = new Unzip($options, $stream);

        $this->assertFalse($unzip->hasZipReadingError());
        $this->assertEquals($has_multiple_root_entries, $unzip->hasMultipleRootEntriesInZip());
        $this->assertEquals($expected_amount_directories, $unzip->getAmountOfDirectories());
        $this->assertEquals($expected_directories, iterator_to_array($unzip->getDirectories()));
        $this->assertEquals($expected_amount_files, $unzip->getAmountOfFiles());
        $this->assertEquals($expected_files, iterator_to_array($unzip->getFiles()));

        $one_file = iterator_to_array($unzip->getFileStreams())[0];

        // check if is binary
        $this->assertTrue(preg_match('~[^\x20-\x7E\t\r\n]~', $one_file->getContents()) > 0);
    }

    public function testWrongZip(): void
    {
        $stream = Streams::ofResource(fopen(__FILE__, 'rb'));
        $options = new UnzipOptions();
        $unzip = new Unzip($options, $stream);
        $this->assertTrue($unzip->hasZipReadingError());
        $this->assertFalse($unzip->hasMultipleRootEntriesInZip());
        $this->assertEquals(0, iterator_count($unzip->getFiles()));
        $this->assertEquals(0, iterator_count($unzip->getDirectories()));
        $this->assertEquals(0, iterator_count($unzip->getPaths()));
        $this->assertEquals([], iterator_to_array($unzip->getDirectories()));
        $this->assertEquals([], iterator_to_array($unzip->getFiles()));
    }

    #[DataProvider('getZips')]
    public function testLegacyUnzip(
        string $zip,
        bool $has_multiple_root_entries,
        int $expected_amount_directories,
        array $expected_directories,
        int $expected_amount_files,
        array $expected_files
    ): void {
        $legacy = new LegacyArchives();

        $this->assertStringContainsString('.zip', $zip);
        $zip_path = $this->zips_dir . $zip;
        $this->assertFileExists($zip_path);

        $temp_unzip_path = $this->unzips_dir . uniqid('unzip', true);

        $return = $legacy->unzip(
            $zip_path,
            $temp_unzip_path
        );

        $this->assertTrue($return);

        $unzipped_files = $this->directoryToArray($temp_unzip_path);
        $expected_paths = array_merge($expected_directories, $expected_files);
        sort($expected_paths);
        $this->assertEquals($expected_paths, $unzipped_files);
        $this->assertTrue($this->recurseRmdir($temp_unzip_path));
    }

    public function testEnsureTopDirectory(): void
    {
        $legacy = new LegacyArchives();
        $zip_path = $this->zips_dir . '3_folders_mac.zip';
        $this->assertFileExists($zip_path);

        $temp_unzip_path = $this->unzips_dir . uniqid('unzip', true);

        $return = $legacy->unzip(
            $zip_path,
            $temp_unzip_path,
            false,
            false,
            true
        );

        $this->assertTrue($return);

        $unzipped_files = $this->directoryToArray($temp_unzip_path);

        $this->assertSame(self::$top_directory_tree, $unzipped_files);
        $this->assertTrue($this->recurseRmdir($temp_unzip_path));
    }

    public function testFlatLegacyUnzip(): void
    {
        $legacy = new LegacyArchives();
        $zip_path = $this->zips_dir . '3_folders_mac.zip';
        $this->assertFileExists($zip_path);

        $temp_unzip_path = $this->unzips_dir . uniqid('unzip', true);

        $return = $legacy->unzip(
            $zip_path,
            $temp_unzip_path,
            false,
            true
        );

        $this->assertTrue($return);

        $unzipped_files = $this->directoryToArray($temp_unzip_path);

        $this->assertSame(self::$expected_flat_files, $unzipped_files);
        $this->assertTrue($this->recurseRmdir($temp_unzip_path));
    }

    private function recurseRmdir(string $path_to_directory): bool
    {
        $files = array_diff(scandir($path_to_directory), ['.', '..']);
        foreach ($files as $file) {
            (is_dir("$path_to_directory/$file") && !is_link("$path_to_directory/$file")) ? $this->recurseRmdir(
                "$path_to_directory/$file"
            ) : unlink("$path_to_directory/$file");
        }
        return rmdir($path_to_directory);
    }

    private function directoryToArray(string $path_to_directory): array
    {
        $iterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($path_to_directory, \RecursiveDirectoryIterator::SKIP_DOTS),
            \RecursiveIteratorIterator::SELF_FIRST,
            \RecursiveIteratorIterator::CATCH_GET_CHILD
        );
        $paths = [];
        foreach ($iterator as $item) {
            $relative_path = str_replace($path_to_directory . '/', '', $item->getPathname());
            $paths[] = $item->isDir() ? $relative_path . '/' : $relative_path;
        }

        sort($paths);

        return $paths;
    }

    // PROVIDERS

    public static function getZips(): array
    {
        return [
            ['1_folder_mac.zip', false, 10, self::$directories_one, 15, self::$files_one],
            ['1_folder_win.zip', false, 10, self::$directories_one, 15, self::$files_one],
            ['3_folders_mac.zip', true, 9, self::$directories_three, 12, self::$files_three],
            ['3_folders_win.zip', true, 9, self::$directories_three, 12, self::$files_three],
            ['1_folder_1_file_mac.zip', true, 3, self::$directories_mixed, 5, self::$files_mixed]
        ];
    }

    protected static array $files_mixed = [
        0 => '03_Test.pdf',
        1 => 'Ordner A/01_Test.pdf',
        2 => 'Ordner A/02_Test.pdf',
        3 => 'Ordner A/Ordner A_2/07_Test.pdf',
        4 => 'Ordner A/Ordner A_2/08_Test.pdf'
    ];

    protected static array $directories_mixed = [
        0 => 'Ordner A/',
        1 => 'Ordner A/Ordner A_1/',
        2 => 'Ordner A/Ordner A_2/'
    ];

    protected static array $directories_one = [
        0 => 'Ordner 0/',
        1 => 'Ordner 0/Ordner A/',
        2 => 'Ordner 0/Ordner A/Ordner A_1/',
        3 => 'Ordner 0/Ordner A/Ordner A_2/',
        4 => 'Ordner 0/Ordner B/',
        5 => 'Ordner 0/Ordner B/Ordner B_1/',
        6 => 'Ordner 0/Ordner B/Ordner B_2/',
        7 => 'Ordner 0/Ordner C/',
        8 => 'Ordner 0/Ordner C/Ordner C_1/',
        9 => 'Ordner 0/Ordner C/Ordner C_2/'
    ];
    protected static array $directories_three = [
        0 => 'Ordner A/',
        1 => 'Ordner A/Ordner A_1/',
        2 => 'Ordner A/Ordner A_2/',
        3 => 'Ordner B/',
        4 => 'Ordner B/Ordner B_1/',
        5 => 'Ordner B/Ordner B_2/',
        6 => 'Ordner C/',
        7 => 'Ordner C/Ordner C_1/',
        8 => 'Ordner C/Ordner C_2/'
    ];

    protected static array $files_one = [
        0 => 'Ordner 0/13_Test.pdf',
        1 => 'Ordner 0/14_Test.pdf',
        2 => 'Ordner 0/15_Test.pdf',
        3 => 'Ordner 0/Ordner A/01_Test.pdf',
        4 => 'Ordner 0/Ordner A/02_Test.pdf',
        5 => 'Ordner 0/Ordner A/Ordner A_2/07_Test.pdf',
        6 => 'Ordner 0/Ordner A/Ordner A_2/08_Test.pdf',
        7 => 'Ordner 0/Ordner B/03_Test.pdf',
        8 => 'Ordner 0/Ordner B/04_Test.pdf',
        9 => 'Ordner 0/Ordner B/Ordner B_2/09_Test.pdf',
        10 => 'Ordner 0/Ordner B/Ordner B_2/10_Test.pdf',
        11 => 'Ordner 0/Ordner C/05_Test.pdf',
        12 => 'Ordner 0/Ordner C/06_Test.pdf',
        13 => 'Ordner 0/Ordner C/Ordner C_2/11_Test.pdf',
        14 => 'Ordner 0/Ordner C/Ordner C_2/12_Test.pdf'
    ];

    protected static array $files_three = [
        0 => 'Ordner A/01_Test.pdf',
        1 => 'Ordner A/02_Test.pdf',
        2 => 'Ordner A/Ordner A_2/07_Test.pdf',
        3 => 'Ordner A/Ordner A_2/08_Test.pdf',
        4 => 'Ordner B/03_Test.pdf',
        5 => 'Ordner B/04_Test.pdf',
        6 => 'Ordner B/Ordner B_2/09_Test.pdf',
        7 => 'Ordner B/Ordner B_2/10_Test.pdf',
        8 => 'Ordner C/05_Test.pdf',
        9 => 'Ordner C/06_Test.pdf',
        10 => 'Ordner C/Ordner C_2/11_Test.pdf',
        11 => 'Ordner C/Ordner C_2/12_Test.pdf',
    ];

    protected static array $top_directory_tree = [
        0 => '3_folders_mac/',
        1 => '3_folders_mac/Ordner A/',
        2 => '3_folders_mac/Ordner A/01_Test.pdf',
        3 => '3_folders_mac/Ordner A/02_Test.pdf',
        4 => '3_folders_mac/Ordner A/Ordner A_1/',
        5 => '3_folders_mac/Ordner A/Ordner A_2/',
        6 => '3_folders_mac/Ordner A/Ordner A_2/07_Test.pdf',
        7 => '3_folders_mac/Ordner A/Ordner A_2/08_Test.pdf',
        8 => '3_folders_mac/Ordner B/',
        9 => '3_folders_mac/Ordner B/03_Test.pdf',
        10 => '3_folders_mac/Ordner B/04_Test.pdf',
        11 => '3_folders_mac/Ordner B/Ordner B_1/',
        12 => '3_folders_mac/Ordner B/Ordner B_2/',
        13 => '3_folders_mac/Ordner B/Ordner B_2/09_Test.pdf',
        14 => '3_folders_mac/Ordner B/Ordner B_2/10_Test.pdf',
        15 => '3_folders_mac/Ordner C/',
        16 => '3_folders_mac/Ordner C/05_Test.pdf',
        17 => '3_folders_mac/Ordner C/06_Test.pdf',
        18 => '3_folders_mac/Ordner C/Ordner C_1/',
        19 => '3_folders_mac/Ordner C/Ordner C_2/',
        20 => '3_folders_mac/Ordner C/Ordner C_2/11_Test.pdf',
        21 => '3_folders_mac/Ordner C/Ordner C_2/12_Test.pdf',
    ];

    private static array $expected_flat_files = [
        0 => '01_Test.pdf',
        1 => '02_Test.pdf',
        2 => '03_Test.pdf',
        3 => '04_Test.pdf',
        4 => '05_Test.pdf',
        5 => '06_Test.pdf',
        6 => '07_Test.pdf',
        7 => '08_Test.pdf',
        8 => '09_Test.pdf',
        9 => '10_Test.pdf',
        10 => '11_Test.pdf',
        11 => '12_Test.pdf',
    ];
}