Merge pull request #39 from kiwilan/develop

ewilan-riviere · web-flow · commit fc7575e8fc8b · 2023-12-06T10:38:08.000+01:00
2.2.0
diff --git a/.github/workflows/run-windows.yml b/.github/workflows/run-windows.yml
@@ -14,7 +14,6 @@ jobs:
           scoop update
           scoop install 7zip
           scoop checkup
-          scoop install unrar
           [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
         shell: powershell
 
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![tests][tests-src]][tests-href]
 [![codecov][codecov-src]][codecov-href]
 
-PHP package to handle archives (`.zip`, `.rar`, `.tar`, `.7z`) or `.pdf` with hybrid solution (native/`p7zip`), designed to works with eBooks (`.epub`, `.cbz`, `.cbr`, `.cb7`, `.cbt`).
+PHP package to handle archives (`.zip`, `.rar`, `.tar`, `.7z`, `.pdf`) with unified API and hybrid solution (native/`p7zip`), designed to works with eBooks (`.epub`, `.cbz`, `.cbr`, `.cb7`, `.cbt`).
 
 Supports Linux, macOS and Windows.
 
@@ -252,15 +252,15 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 
 [<img src="https://user-images.githubusercontent.com/48261459/201463225-0a5a084e-df15-4b11-b1d2-40fafd3555cf.svg" height="120rem" width="100%" />](https://github.com/kiwilan)
 
-[version-src]: https://img.shields.io/packagist/v/kiwilan/php-archive.svg?style=flat-square&colorA=18181B&colorB=777BB4
+[version-src]: https://img.shields.io/packagist/v/kiwilan/php-archive.svg?style=flat&colorA=18181B&colorB=777BB4
 [version-href]: https://packagist.org/packages/kiwilan/php-archive
-[php-version-src]: https://img.shields.io/static/v1?style=flat-square&label=PHP&message=v8.1&color=777BB4&logo=php&logoColor=ffffff&labelColor=18181b
+[php-version-src]: https://img.shields.io/static/v1?style=flat&label=PHP&message=v8.1&color=777BB4&logo=php&logoColor=ffffff&labelColor=18181b
 [php-version-href]: https://www.php.net/
-[downloads-src]: https://img.shields.io/packagist/dt/kiwilan/php-archive.svg?style=flat-square&colorA=18181B&colorB=777BB4
+[downloads-src]: https://img.shields.io/packagist/dt/kiwilan/php-archive.svg?style=flat&colorA=18181B&colorB=777BB4
 [downloads-href]: https://packagist.org/packages/kiwilan/php-archive
-[license-src]: https://img.shields.io/github/license/kiwilan/php-archive.svg?style=flat-square&colorA=18181B&colorB=777BB4
+[license-src]: https://img.shields.io/github/license/kiwilan/php-archive.svg?style=flat&colorA=18181B&colorB=777BB4
 [license-href]: https://github.com/kiwilan/php-archive/blob/main/README.md
-[tests-src]: https://img.shields.io/github/actions/workflow/status/kiwilan/php-archive/run-tests.yml?branch=main&label=tests&style=flat-square&colorA=18181B
+[tests-src]: https://img.shields.io/github/actions/workflow/status/kiwilan/php-archive/run-tests.yml?branch=main&label=tests&style=flat&colorA=18181B
 [tests-href]: https://github.com/kiwilan/php-archive/actions/workflows/run-tests.yml
-[codecov-src]: https://codecov.io/gh/kiwilan/php-archive/branch/main/graph/badge.svg?token=P9XIK2KV9G
+[codecov-src]: https://img.shields.io/codecov/c/gh/kiwilan/php-archive/main?style=flat&colorA=18181B&colorB=777BB4
 [codecov-href]: https://codecov.io/gh/kiwilan/php-archive
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "kiwilan/php-archive",
-    "version": "2.1.02",
-    "description": "PHP package to handle archives (.zip, .rar, .tar, .7z) or .pdf with hybrid solution (native/p7zip), designed to works with eBooks (.epub, .cbz, .cbr, .cb7, .cbt).",
+    "version": "2.2.0",
+    "description": "PHP package to handle archives (.zip, .rar, .tar, .7z, .pdf) with unified API and hybrid solution (native/p7zip), designed to works with eBooks (.epub, .cbz, .cbr, .cb7, .cbt).",
     "keywords": [
         "php",
         "archive",
@@ -34,8 +34,7 @@
     "require": {
         "php": "^8.1",
         "smalot/pdfparser": "^2.4",
-        "spatie/temporary-directory": "^2.1",
-        "symfony/process": "^6.2"
+        "spatie/temporary-directory": "^2.1"
     },
     "require-dev": {
         "laravel/pint": "^1.6",
diff --git a/src/ArchiveTemporaryDirectory.php b/src/ArchiveTemporaryDirectory.php
@@ -13,7 +13,7 @@ protected function __construct(
     ) {
     }
 
-    public static function make(string $filename = null): self
+    public static function make(?string $filename = null): self
     {
         return new self(uniqid(), $filename);
     }
diff --git a/src/Enums/ArchiveEnum.php b/src/Enums/ArchiveEnum.php
@@ -10,7 +10,7 @@ enum ArchiveEnum: string
     case rar = 'rar';
     case pdf = 'pdf';
 
-    public static function fromExtension(string $extension, string $mimeType = null): self
+    public static function fromExtension(string $extension, ?string $mimeType = null): self
     {
         $extension = strtolower($extension);
         if (str_contains($extension, '.')) {
diff --git a/src/Models/ArchiveItem.php b/src/Models/ArchiveItem.php
@@ -34,7 +34,7 @@ public function __construct(
     ) {
     }
 
-    public static function fromP7zip(array $data, string $archivePath = null): self
+    public static function fromP7zip(array $data, ?string $archivePath = null): self
     {
         if (empty($data)) {
             throw new \Exception('No data provided.');
diff --git a/src/Processes/SevenZipProcess.php b/src/Processes/SevenZipProcess.php
@@ -6,8 +6,6 @@
 use Kiwilan\Archive\ArchiveTemporaryDirectory;
 use Kiwilan\Archive\Models\ArchiveItem;
 use Kiwilan\Archive\Readers\BaseArchive;
-use Symfony\Component\Process\Exception\ProcessFailedException;
-use Symfony\Component\Process\Process;
 
 class SevenZipProcess
 {
@@ -40,21 +38,62 @@ public static function make(string $path): self
         return $self;
     }
 
+    public static function test(bool $exception = true): bool
+    {
+        exec('7z', $output, $res);
+        // $process = new Process(['7z']);
+        // $process->run();
+
+        $isValid = $res === 0;
+        // $isValid = $process->isSuccessful();
+
+        // check if 7z is installed
+        if (! $isValid) {
+            if ($exception) {
+                $osFamily = PHP_OS_FAMILY;
+                $isDarwin = $osFamily === 'Darwin';
+                $message = "p7zip is not installed or not in the PATH. Please install p7zip and try again.\nYou can check this guide: https://gist.github.com/ewilan-riviere/85d657f9283fa6af255531d97da5d71d";
+
+                if ($isDarwin) {
+                    $message .= "\nYou have to install `rar` binary with brew on macOS.";
+                }
+
+                throw new Exception($message);
+            }
+
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * @param  string[]  $args
+     * @return string[]
      */
-    public function execute(string $command, array $args): string
+    public function execute(string $command, array $args): array
     {
-        BaseArchive::binaryP7zipTest();
+        SevenZipProcess::test();
+
+        $command = "{$command} ".implode(' ', $args);
 
-        $process = new Process([$command, ...$args]);
-        $process->run();
+        // $process = new Process([$command, ...$args]);
+        // $process->run();
 
-        if (! $process->isSuccessful()) {
-            throw new ProcessFailedException($process);
+        // if (! $process->isSuccessful()) {
+        //     throw new ProcessFailedException($process);
+        // }
+
+        try {
+            exec($command, $output, $res);
+        } catch (\Throwable $th) {
+            throw new \Error($th->getMessage());
         }
 
-        return $process->getOutput();
+        // $output = explode(PHP_EOL, $output);
+        array_unshift($output, '');
+
+        return $output;
     }
 
     /**
@@ -64,9 +103,6 @@ public function list(): array
     {
         $output = $this->execute('7z', ['l', '-ba', '-slt', $this->path]);
 
-        $output = explode(PHP_EOL, $output);
-        array_unshift($output, '');
-
         $temp = [];
         foreach ($output as $string) {
             if (empty($string)) {
@@ -96,8 +132,13 @@ public function list(): array
                 $key = array_key_exists(0, $data) ? $data[0] : null;
                 $value = array_key_exists(1, $data) ? $data[1] : null;
 
-                $key = trim($key);
-                $value = trim($value);
+                if ($key) {
+                    $key = trim($key);
+                }
+
+                if ($value) {
+                    $value = trim($value);
+                }
 
                 $item[$key] = $value;
             }
@@ -115,7 +156,7 @@ public function list(): array
     /**
      * @param  ArchiveItem[]  $files
      */
-    public function extract(string $toPath, array $files = null): bool
+    public function extract(string $toPath, ?array $files = null): bool
     {
         if ($this->isRar && $this->isDarwin) {
             if ($files) {
diff --git a/src/Readers/ArchiveRar.php b/src/Readers/ArchiveRar.php
@@ -84,7 +84,7 @@ public function getText(ArchiveItem $file): ?string
             throw new \Exception("Error, {$file->getFilename()} is an image");
         }
 
-        return $this->getContent($file);
+        return $this->getContents($file);
     }
 
     private function parse(): static
diff --git a/src/Readers/ArchiveSevenZip.php b/src/Readers/ArchiveSevenZip.php
@@ -45,7 +45,7 @@ public function getText(ArchiveItem $file): ?string
             throw new \Exception("Error, {$file->getFilename()} is an image");
         }
 
-        return $this->getContent($file);
+        return $this->getContents($file);
     }
 
     public function extract(string $toPath, array $files): array
diff --git a/src/Readers/ArchiveZip.php b/src/Readers/ArchiveZip.php
@@ -23,7 +23,7 @@ public function extract(string $toPath, array $files): array
         $paths = [];
         $this->parser(function (ArchiveItem $item, ZipArchive $archive, int $i) use (&$files, $toPath, &$paths) {
             if (in_array($item, $files)) {
-                $content = $this->getContent($item);
+                $content = $this->getContents($item);
                 $toPathFile = "{$toPath}{$item->getRootPath()}";
 
                 if (! is_dir(dirname($toPathFile))) {
@@ -82,7 +82,7 @@ public function getText(ArchiveItem $file): ?string
             throw new \Exception("Error, {$file->getFilename()} is an image");
         }
 
-        return $this->getContent($file);
+        return $this->getContents($file);
     }
 
     private function parse(): static
diff --git a/src/Readers/BaseArchive.php b/src/Readers/BaseArchive.php
@@ -3,18 +3,17 @@
 namespace Kiwilan\Archive\Readers;
 
 use DateTime;
-use Exception;
 use FilesystemIterator;
 use Kiwilan\Archive\Archive;
 use Kiwilan\Archive\ArchiveTemporaryDirectory;
 use Kiwilan\Archive\Enums\ArchiveEnum;
 use Kiwilan\Archive\Models\ArchiveItem;
 use Kiwilan\Archive\Models\ArchiveStat;
 use Kiwilan\Archive\Models\PdfMeta;
+use Kiwilan\Archive\Processes\SevenZipProcess;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
 use SplFileInfo;
-use Symfony\Component\Process\Process;
 
 abstract class BaseArchive
 {
@@ -298,26 +297,7 @@ protected static function extensionRarTest(bool $exception = true): bool
 
     public static function binaryP7zipTest(bool $exception = true): bool
     {
-        $process = new Process(['7z']);
-        $process->run();
-
-        if (! $process->isSuccessful()) {
-            if ($exception) {
-                $osFamily = PHP_OS_FAMILY;
-                $isDarwin = $osFamily === 'Darwin';
-                $message = "p7zip is not installed or not in the PATH. Please install p7zip and try again.\nYou can check this guide: https://gist.github.com/ewilan-riviere/85d657f9283fa6af255531d97da5d71d";
-
-                if ($isDarwin) {
-                    $message .= "\nYou have to install `rar` binary with brew on macOS.";
-                }
-
-                throw new Exception($message);
-            }
-
-            return false;
-        }
-
-        return true;
+        return SevenZipProcess::test($exception);
     }
 
     protected function getAllFiles(string $path): array
diff --git a/tests/ArchiveTest.php b/tests/ArchiveTest.php
@@ -79,7 +79,7 @@ function (Pest\Expectation $item) use ($ext) {
     expect($content)->toBeString();
     expect($file)->toBeReadableFile();
 
-    $content = $archive->getContent($archive->getFirst());
+    $content = $archive->getContents($archive->getFirst());
 })->with([...ARCHIVES_ZIP, ...ARCHIVES_TAR, ...ARCHIVES_RAR, SEVENZIP]);
 
 it('can get cover', function (string $path) {
@@ -99,7 +99,7 @@ function (Pest\Expectation $item) use ($ext) {
 it('can cover with base64', function (string $path) {
     $archive = Archive::read($path);
     $cover = $archive->find('cover.jpeg');
-    $content = $archive->getContent($cover, true);
+    $content = $archive->getContents($cover, true);
     $isBase64 = isBase64($content);
 
     expect($isBase64)->toBeTrue();
diff --git a/tests/PdfTest.php b/tests/PdfTest.php
@@ -26,7 +26,7 @@
 
     expect($content)->toBeString();
     expect($file)->toBeReadableFile();
-})->skip(PHP_OS_FAMILY === 'Windows', 'Not supported on Windows');
+})->skip(PHP_OS_FAMILY === 'Windows' || PHP_VERSION >= '8.3', 'Not supported on Windows');
 
 it('can extract some files', function () {
     $archive = Archive::read(PDF);
@@ -40,15 +40,15 @@
     expect($paths)->toHaveCount(2);
     expect($paths[0])->toBeString();
     expect($paths[0])->toBeReadableFile();
-})->skip(PHP_OS_FAMILY === 'Windows', 'Not supported on Windows');
+})->skip(PHP_OS_FAMILY === 'Windows' || PHP_VERSION >= '8.3', 'Not supported on Windows');
 
 it('can extract files', function () {
     $archive = Archive::read(PDF);
     $paths = $archive->extractAll(outputPath());
 
     expect($paths)->toBeArray();
     expect($paths)->toBeGreaterThanOrEqual(5);
-})->skip(PHP_OS_FAMILY === 'Windows', 'Not supported on Windows');
+})->skip(PHP_OS_FAMILY === 'Windows' || PHP_VERSION >= '8.3', 'Not supported on Windows');
 
 it('can read metadata', function () {
     $archive = Archive::read(PDF);
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -64,7 +64,7 @@ function mediaPath(string $filename): string
     return $pathBase.$filename;
 }
 
-function outputPath(string $path = null, string $filename = null): string
+function outputPath(?string $path = null, ?string $filename = null): string
 {
     $pathBase = __DIR__.'/output/';
 

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ protected function __construct(`
`13`	`13`	`) {`
`14`	`14`	`}`
`15`	`15`
`16`		`- public static function make(string $filename = null): self`
	`16`	`+ public static function make(?string $filename = null): self`
`17`	`17`	`{`
`18`	`18`	`return new self(uniqid(), $filename);`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ enum ArchiveEnum: string`
`10`	`10`	`case rar = 'rar';`
`11`	`11`	`case pdf = 'pdf';`
`12`	`12`
`13`		`- public static function fromExtension(string $extension, string $mimeType = null): self`
	`13`	`+ public static function fromExtension(string $extension, ?string $mimeType = null): self`
`14`	`14`	`{`
`15`	`15`	`$extension = strtolower($extension);`
`16`	`16`	`if (str_contains($extension, '.')) {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct(`
`34`	`34`	`) {`
`35`	`35`	`}`
`36`	`36`
`37`		`- public static function fromP7zip(array $data, string $archivePath = null): self`
	`37`	`+ public static function fromP7zip(array $data, ?string $archivePath = null): self`
`38`	`38`	`{`
`39`	`39`	`if (empty($data)) {`
`40`	`40`	`throw new \Exception('No data provided.');`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function getText(ArchiveItem $file): ?string`
`84`	`84`	`throw new \Exception("Error, {$file->getFilename()} is an image");`
`85`	`85`	`}`
`86`	`86`
`87`		`- return $this->getContent($file);`
	`87`	`+ return $this->getContents($file);`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`private function parse(): static`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function getText(ArchiveItem $file): ?string`
`45`	`45`	`throw new \Exception("Error, {$file->getFilename()} is an image");`
`46`	`46`	`}`
`47`	`47`
`48`		`- return $this->getContent($file);`
	`48`	`+ return $this->getContents($file);`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`public function extract(string $toPath, array $files): array`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function extract(string $toPath, array $files): array`
`23`	`23`	`$paths = [];`
`24`	`24`	`$this->parser(function (ArchiveItem $item, ZipArchive $archive, int $i) use (&$files, $toPath, &$paths) {`
`25`	`25`	`if (in_array($item, $files)) {`
`26`		`- $content = $this->getContent($item);`
	`26`	`+ $content = $this->getContents($item);`
`27`	`27`	`$toPathFile = "{$toPath}{$item->getRootPath()}";`
`28`	`28`
`29`	`29`	`if (! is_dir(dirname($toPathFile))) {`
`@@ -82,7 +82,7 @@ public function getText(ArchiveItem $file): ?string`
`82`	`82`	`throw new \Exception("Error, {$file->getFilename()} is an image");`
`83`	`83`	`}`
`84`	`84`
`85`		`- return $this->getContent($file);`
	`85`	`+ return $this->getContents($file);`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`private function parse(): static`