use new class instead of existing one

Author: MaximeBICMTL

modules/api/php/endpoints/candidate/visit/electrophysiology/recording.class.inc

@@ -170,7 +170,8 @@ class Recording extends Endpoint implements \LORIS\Middleware\ETagCalculator
             return new \LORIS\Http\Response\JSON\NotFound($e->getMessage());
         }
 
-        $info = $recording->getFileInfo();
+        $info     = $recording->getFileInfo();
+        $filepath = $info->getRealPath();
 
         if (!$info->isFile() && !$info->isDir()) {
             error_log('file in database but not in file system');
@@ -187,35 +188,15 @@ class Recording extends Endpoint implements \LORIS\Middleware\ETagCalculator
         if ($info->isDir()) {
             $filename = $this->_filename . '.tar';
             $mimetype = 'application/x-tar';
-
-            $tarfile = sys_get_temp_dir() . '/recording_' . uniqid() . '.tar';
-
-            try {
-                $phar = new \PharData($tarfile);
-                $phar->buildFromDirectory($info->getRealPath());
-            } catch (\Exception $e) {
-                $this->logger->error(
-                    'Failed to create tar archive: ' . $e->getMessage()
-                );
-
-                if (file_exists($tarfile)) {
-                    unlink($tarfile);
-                }
-
-                return new \LORIS\Http\Response\JSON\InternalServerError();
-            }
-
-            $filepath = $tarfile;
+            $body     = new \LORIS\Http\ArchiveStream($filepath);
         } else {
             $filename = $this->_filename;
-            $filepath = $info->getRealPath();
             $mimetype = substr($recording->getMetadata('header'), 0, 4) === 'hdf5'
                 ? 'application/x.minc2'
                 : 'application/octet-stream';
+            $body     = new \LORIS\Http\FileStream($filepath, 'r');
         }
 
-        $body = new \LORIS\Http\FileStream($filepath, 'r', true);
-
         return (new \LORIS\Http\Response())
             ->withHeader('Content-Type', $mimetype)
             ->withHeader(

src/Http/ArchiveStream.php

@@ -0,0 +1,66 @@
+<?php declare(strict_types=1);
+
+/**
+ * This file implements an ArchiveStream, which creates a temporary tar archive
+ * from a directory and provides it as a PSR7 StreamInterface.
+ *
+ * @category PSR7
+ * @package  Http
+ * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
+ * @link     https://www.github.com/aces/Loris/
+ *
+ * @see https://www.php-fig.org/psr/psr-7/
+ */
+namespace LORIS\Http;
+
+/**
+ * An ArchiveStream creates a temporary tar archive from a directory
+ * and provides it as a PSR7 StreamInterface. The temporary archive file
+ * is deleted when the stream is closed.
+ *
+ * @category PSR7
+ * @package  Http
+ * @license  http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
+ * @link     https://www.github.com/aces/Loris/
+ */
+class ArchiveStream extends \Laminas\Diactoros\Stream implements \Psr\Http\Message\StreamInterface
+{
+    /**
+     * The path to the temporary archive file
+     *
+     * @var string
+     */
+    private string $archivePath;
+
+    /**
+     * Constructor
+     *
+     * Creates a tar archive from the given directory and opens it as a stream.
+     * The archive file is deleted when the stream is closed.
+     *
+     * @param string $directoryPath The path to the directory to archive
+     *
+     * @throws \Exception if archive creation fails
+     */
+    public function __construct(string $directoryPath)
+    {
+        $this->archivePath = sys_get_temp_dir() . '/' . uniqid() . '.tar';
+
+        $phar = new \PharData($this->archivePath);
+        $phar->buildFromDirectory($directoryPath);
+
+        parent::__construct($this->archivePath, 'r');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function close(): void
+    {
+        parent::close();
+
+        if (file_exists($this->archivePath)) {
+            unlink($this->archivePath);
+        }
+    }
+}

src/Http/FileStream.php

@@ -27,38 +27,4 @@
  */
 class FileStream extends \Laminas\Diactoros\Stream implements \Psr\Http\Message\StreamInterface
 {
-    /**
-     * @var bool Whether the file be deleted when the stream is closed, used for
-     *           temporary files.
-     */
-    private bool $deleteOnClose;
-
-    /**
-     * Constructor
-     *
-     * @param string $stream        The path to the file or a stream resource
-     * @param string $mode          The mode to open the stream with
-     * @param bool   $deleteOnClose If true, delete the file when the stream is closed
-     */
-    public function __construct(
-        string $stream,
-        string $mode = 'r',
-        bool $deleteOnClose = false,
-    ) {
-        parent::__construct($stream, $mode);
-        $this->deleteOnClose = $deleteOnClose;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function close(): void
-    {
-        if ($this->deleteOnClose
-            && is_string($this->resource)
-            && file_exists($this->resource)
-        ) {
-            unlink($this->resource);
-        }
-    }
 }