wip: pauses downloads

src/Download/Action/Command/PauseDownloadCommand.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Download\Action\Command;
+
+use OneToMany\RichBundle\Contract\CommandInterface;
+
+/**
+ * @implements CommandInterface<PauseDownloadCommand>
+ */
+class PauseDownloadCommand implements CommandInterface
+{
+    public function __construct(
+        public int $downloadId,
+    ) {}
+}

src/Download/Action/Handler/DownloadMediaHandler.php

@@ -47,7 +47,9 @@ readonly class DownloadMediaHandler implements HandlerInterface
                 $download->getId()
             );
 
-            $this->downloadRepository->updateStatus($download->getId(), 'Complete');
+            if ($download->getStatus() !== 'Paused') {
+                $this->downloadRepository->updateStatus($download->getId(), 'Complete');
+            }
 
         } catch (\Throwable $exception) {
             throw new UnrecoverableMessageHandlingException($exception->getMessage(), 500);

src/Download/Action/Handler/PauseDownloadHandler.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace App\Download\Action\Handler;
+
+use App\Download\Action\Command\PauseDownloadCommand;
+use App\Download\Action\Result\PauseDownloadResult;
+use App\Download\Framework\Entity\Download;
+use App\Download\Framework\Repository\DownloadRepository;
+use App\Monitor\Service\MediaFiles;
+use OneToMany\RichBundle\Contract\CommandInterface;
+use OneToMany\RichBundle\Contract\HandlerInterface;
+use OneToMany\RichBundle\Contract\ResultInterface;
+use Symfony\Contracts\Cache\CacheInterface;
+
+/** @implements HandlerInterface<PauseDownloadCommand, PauseDownloadResult> */
+readonly class PauseDownloadHandler implements HandlerInterface
+{
+    const PAUSED_EXTENSION = '.paused';
+
+    public function __construct(
+        private DownloadRepository $downloadRepository,
+        private MediaFiles $mediaFiles,
+        private CacheInterface $cache,
+    ) {}
+
+    public function handle(CommandInterface $command): ResultInterface
+    {
+        /** @var Download $download */
+        $download = $this->downloadRepository->find($command->downloadId);
+
+        $this->cache->get('download.pause.' . $download->getId(), function () {
+            return true;
+        });
+
+        $download->setFilename($download->getFilename() . self::PAUSED_EXTENSION);
+
+        return new PauseDownloadResult(200, 'Success', $download);
+    }
+}

src/Download/Action/Input/PauseDownloadInput.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Download\Action\Input;
+
+use App\Download\Action\Command\PauseDownloadCommand;
+use OneToMany\RichBundle\Attribute\SourceRoute;
+use OneToMany\RichBundle\Contract\CommandInterface;
+use OneToMany\RichBundle\Contract\InputInterface;
+
+/** @implements InputInterface<PauseDownloadInput, PauseDownloadCommand> */
+class PauseDownloadInput implements InputInterface
+{
+    public function __construct(
+        #[SourceRoute('downloadId')]
+        public int $downloadId,
+    ) {}
+
+    public function toCommand(): CommandInterface
+    {
+        return new PauseDownloadCommand(
+            $this->downloadId,
+        );
+    }
+}

src/Download/Action/Result/PauseDownloadResult.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Download\Action\Result;
+
+use App\Download\Framework\Entity\Download;
+use OneToMany\RichBundle\Contract\ResultInterface;
+
+/** @implements ResultInterface<PauseDownloadResult> */
+class PauseDownloadResult implements ResultInterface
+{
+    public function __construct(
+        public int $status,
+        public string $message,
+        public Download $download,
+    ) {}
+}

src/Download/Downloader/ProcessDownloader.php

@@ -7,12 +7,14 @@ use App\Monitor\Service\MediaFiles;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
+use Symfony\Contracts\Cache\CacheInterface;
 
 class ProcessDownloader implements DownloaderInterface
 {
     public function __construct(
         private EntityManagerInterface $entityManager,
         private MediaFiles $mediaFiles,
+        private CacheInterface $cache,
     ) {}
 
     /**
@@ -30,7 +32,7 @@ class ProcessDownloader implements DownloaderInterface
 
         $process = (new Process([
             'wget',
-            $url
+            $url,
         ]))->setWorkingDirectory($path);
 
         $process->setTimeout(1800); // 30 min
@@ -41,7 +43,18 @@ class ProcessDownloader implements DownloaderInterface
         try {
             $progress = 0;
             $this->entityManager->flush();
-            $process->wait(function ($type, $buffer) use ($progress, $downloadEntity): void {
+
+            $process->wait(function ($type, $buffer) use ($progress, $downloadEntity, $process): void {
+                // The PauseDownloadHandler will set this to 'true'
+                $doPause = $this->cache->getItem('download.pause.' . $downloadEntity->getId());
+
+                if (true === $doPause->isHit()) {
+                    $downloadEntity->setStatus('Paused');
+                    $this->entityManager->flush();
+                    $doPause->expiresAt(new \DateTimeImmutable('now'));
+                    $process->stop();
+                }
+
                 if (Process::ERR === $type) {
                     $pregMatchOutput = [];
                     preg_match('/[\d]+%/', $buffer, $pregMatchOutput);
@@ -56,7 +69,9 @@ class ProcessDownloader implements DownloaderInterface
                 }
                 fwrite(STDOUT, $buffer);
             });
-            $downloadEntity->setProgress(100);
+            if ($downloadEntity->getStatus() !== 'Paused') {
+                $downloadEntity->setProgress(100);
+            }
         } catch (ProcessFailedException $exception) {
             $downloadEntity->setStatus('Failed');
         }

src/Download/Framework/Controller/ApiController.php

@@ -3,8 +3,10 @@
 namespace App\Download\Framework\Controller;
 
 use App\Download\Action\Handler\DeleteDownloadHandler;
+use App\Download\Action\Handler\PauseDownloadHandler;
 use App\Download\Action\Input\DeleteDownloadInput;
 use App\Download\Action\Input\DownloadMediaInput;
+use App\Download\Action\Input\PauseDownloadInput;
 use App\Download\Framework\Repository\DownloadRepository;
 use App\Util\Broadcaster;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
@@ -65,4 +67,18 @@ class ApiController extends AbstractController
 
         return $this->json(['status' => 200, 'message' => 'Download Deleted']);
     }
+
+    #[Route('/api/download/{downloadId}', name: 'api_download_pause', methods: ['PUT'])]
+    public function pauseDownload(
+        PauseDownloadInput $input,
+        PauseDownloadHandler $handler,
+    ): Response {
+        $result = $handler->handle($input->toCommand());
+        $this->broadcaster->alert(
+            title: 'Success',
+            message: "{$result->download->getTitle()} has been Paused.",
+        );
+
+        return $this->json(['status' => 200, 'message' => 'Download Paused']);
+    }
 }

src/Download/Framework/Repository/DownloadRepository.php

@@ -47,7 +47,7 @@ class DownloadRepository extends ServiceEntityRepository
             ->andWhere('d.user = :user')
             ->andWhere('(d.title LIKE :term OR d.filename LIKE :term OR d.imdbId LIKE :term OR d.status LIKE :term OR d.mediaType LIKE :term)')
             ->orderBy('d.id', 'ASC')
-            ->setParameter('statuses', ['New', 'In Progress'])
+            ->setParameter('statuses', ['New', 'In Progress', 'Paused'])
             ->setParameter('user', $user)
             ->setParameter('term', '%' . $term . '%')
             ->getQuery();