Use the kepub url extension to provide the ebook to kobo

ragusa87 · Aug 18, 2024 · 5d5780b · 5d5780b
1 parent 417a234
commit 5d5780b
Show file tree

Hide file tree

Showing 7 changed files with 140 additions and 22 deletions.
diff --git a/src/Controller/Kobo/KoboDownloadController.php b/src/Controller/Kobo/KoboDownloadController.php
@@ -25,11 +25,11 @@ public function __construct(
     }
 
     #[Route('/v1/download/{id}.{extension}', name: 'download', requirements: ['bookId' => '\d+', 'extension' => '[A-Za-z0-9]+'], methods: ['GET'])]
-    public function download(KoboDevice $kobo, Book $book): Response
+    public function download(KoboDevice $kobo, Book $book, string $extension): Response
     {
         $this->assertCanDownload($kobo, $book);
 
-        return $this->downloadHelper->getResponse($book);
+        return $this->downloadHelper->getResponse($book, $extension);
     }
 
     private function assertCanDownload(KoboDevice $kobo, Book $book): void

diff --git a/src/Kobo/DownloadHelper.php b/src/Kobo/DownloadHelper.php
@@ -6,7 +6,8 @@
 use App\Entity\KoboDevice;
 use App\Exception\BookFileNotFound;
 use App\Kobo\ImageProcessor\CoverTransformer;
-use App\Kobo\Messenger\KepubifyMessage;
+use App\Kobo\Kepubify\KepubifyMessage;
+use App\Kobo\Response\MetadataResponseService;
 use App\Service\BookFileSystemManager;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
@@ -43,12 +44,12 @@ public function getCoverSize(Book $book): int
         return $this->fileSystemManager->getCoverSize($book) ?? 0;
     }
 
-    public function getUrlForKoboDevice(Book $book, KoboDevice $kobo): string
+    public function getUrlForKoboDevice(Book $book, KoboDevice $kobo, string $extension): string
     {
         return $this->urlGenerator->generate('app_kobodownload', [
             'id' => $book->getId(),
             'accessKey' => $kobo->getAccessKey(),
-            'extension' => $book->getExtension(),
+            'extension' => $extension,
         ], UrlGeneratorInterface::ABSOLUTE_URL);
     }
 
@@ -91,27 +92,37 @@ public function getCoverResponse(Book $book, int $width, int $height, bool $gray
         return $response;
     }
 
-    public function getResponse(Book $book): Response
+    /**
+     * @throws NotFoundHttpException Book conversion failed
+     */
+    public function getResponse(Book $book, string $format): Response
     {
         $bookPath = $this->getBookFilename($book);
         if (false === $this->exists($book)) {
             throw new BookFileNotFound($bookPath);
         }
 
-        // Convert the file to kepub (Kobo's epub format) as a temporary file
-        $temporaryFile = $this->runKepubify($bookPath);
+        $temporaryFile = null;
+
+        if ($format === MetadataResponseService::KEPUB_FORMAT) {
+            $temporaryFile = $this->runKepubify($bookPath);
+            if ($temporaryFile === null) {
+                throw new NotFoundHttpException('The conversion to KEPUB failed');
+            }
+        }
+
         $fileToStream = $temporaryFile ?? $bookPath;
         $fileSize = filesize($fileToStream);
 
         $response = (new BinaryFileResponse($fileToStream, Response::HTTP_OK))
             ->deleteFileAfterSend($temporaryFile !== null);
 
-        $filename = $book->getBookFilename();
+        $filename = basename($book->getBookFilename(), $book->getExtension()).strtolower($format);
         $encodedFilename = rawurlencode($filename);
         $simpleName = rawurlencode(sprintf('book-%s-%s', $book->getId(), preg_replace('/[^a-zA-Z0-9\.\-_]/', '_', $filename)));
 
-        $response->headers->set('Content-Type', match (strtolower($book->getExtension())) {
-            'epub', 'epub3' => 'application/epub+zip',
+        $response->headers->set('Content-Type', match (strtoupper($format)) {
+            MetadataResponseService::KEPUB_FORMAT, MetadataResponseService::EPUB_FORMAT, MetadataResponseService::EPUB3_FORMAT => 'application/epub+zip',
             default => 'application/octet-stream'
         });
         $response->headers->set('Content-Disposition', HeaderUtils::makeDisposition(HeaderUtils::DISPOSITION_ATTACHMENT, $encodedFilename, $simpleName));

diff --git a/src/Kobo/Kepubify/KepubifyEnabler.php b/src/Kobo/Kepubify/KepubifyEnabler.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Kobo\Kepubify;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+
+class KepubifyEnabler
+{
+    public function __construct(
+        #[Autowire(param: 'KEPUBIFY_BIN')]
+        private string $kepubifyBinary
+    ) {
+    }
+
+    public function setKepubifyBinary(string $kepubifyBinary): void
+    {
+        $this->kepubifyBinary = $kepubifyBinary;
+    }
+
+    public function isEnabled(): bool
+    {
+        return trim($this->kepubifyBinary) !== '';
+    }
+
+    public function getKepubifyBinary(): string
+    {
+        return $this->kepubifyBinary;
+    }
+
+    public function disable(): string
+    {
+        $lastValue = $this->kepubifyBinary;
+        $this->kepubifyBinary = '';
+
+        return $lastValue;
+    }
+}
diff --git a/src/Kobo/Messenger/KepubifyMessage.php → src/Kobo/Kepubify/KepubifyMessage.php b/src/Kobo/Messenger/KepubifyMessage.php → src/Kobo/Kepubify/KepubifyMessage.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Kobo\Messenger;
+namespace App\Kobo\Kepubify;
 
 /**
  * Convert an ebook with kepubify binary

diff --git a/...Kobo/Messenger/KepubifyMessageHandler.php → src/Kobo/Kepubify/KepubifyMessageHandler.php b/...Kobo/Messenger/KepubifyMessageHandler.php → src/Kobo/Kepubify/KepubifyMessageHandler.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Kobo\Messenger;
+namespace App\Kobo\Kepubify;
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
@@ -17,15 +17,14 @@ public function __construct(
         #[Autowire(param: 'kernel.cache_dir')]
         private readonly string $cacheDir,
         private readonly LoggerInterface $logger,
-        #[Autowire(param: 'KEPUBIFY_BIN')]
-        private string $kepubifyBinary
+        private KepubifyEnabler $kepubifyEnabler
     ) {
     }
 
     public function __invoke(KepubifyMessage $message): void
     {
         // Disable kepubify if the path is not set
-        if (trim($this->kepubifyBinary) === '') {
+        if (false === $this->kepubifyEnabler->isEnabled()) {
             return;
         }
 
@@ -38,7 +37,7 @@ public function __invoke(KepubifyMessage $message): void
         }
 
         // Run the conversion
-        $process = new Process([$this->kepubifyBinary, '--output', $temporaryFile, $message->source]);
+        $process = new Process([$this->kepubifyEnabler->getKepubifyBinary(), '--output', $temporaryFile, $message->source]);
         $this->logger->debug('Run kepubify command: {command}', ['command' => $process->getCommandLine()]);
         $process->run();
 

diff --git a/src/Kobo/Response/MetadataResponseService.php b/src/Kobo/Response/MetadataResponseService.php
@@ -5,11 +5,18 @@
 use App\Entity\Book;
 use App\Entity\KoboDevice;
 use App\Kobo\DownloadHelper;
+use App\Kobo\Kepubify\KepubifyEnabler;
 use App\Kobo\SyncToken;
 
 class MetadataResponseService
 {
-    public function __construct(protected DownloadHelper $downloadHelper)
+    public const KEPUB_FORMAT = 'KEPUB';
+    public const EPUB3_FORMAT = 'EPUB3';
+    public const EPUB_FORMAT = 'EPUB';
+
+    public function __construct(
+        protected DownloadHelper $downloadHelper,
+        protected KepubifyEnabler $kepubifyEnabler)
     {
     }
 
@@ -21,12 +28,17 @@ protected function getDownloadUrls(Book $book, KoboDevice $kobo, ?array $filters
 
         $response = [];
 
-        $formats = ['EPUB3']; // EPUB3 is required for Kobo
+        $formats = [self::EPUB3_FORMAT]; // At least EPUB3 is required for Kobo
+        if ($this->kepubifyEnabler->isEnabled()) {
+            $formats[] = self::KEPUB_FORMAT;
+        }
+
         foreach ($formats as $format) { // and ... EPUB3FL ?;
+            $extension = $format === self::KEPUB_FORMAT ? $format : $book->getExtension();
             $response[] = [
                 'Format' => $format,
                 'Size' => $this->downloadHelper->getSize($book),
-                'Url' => $this->downloadHelper->getUrlForKoboDevice($book, $kobo),
+                'Url' => $this->downloadHelper->getUrlForKoboDevice($book, $kobo, $extension),
                 'Platform' => $platform,
             ];
         }

diff --git a/tests/Controller/Kobo/KoboDownloadControllerTest.php b/tests/Controller/Kobo/KoboDownloadControllerTest.php
@@ -6,6 +6,8 @@
 use App\Entity\Book;
 use App\Entity\KoboDevice;
 use App\Kobo\DownloadHelper;
+use App\Kobo\Kepubify\KepubifyEnabler;
+use App\Kobo\Response\MetadataResponseService;
 
 class KoboDownloadControllerTest extends AbstractKoboControllerTest
 {
@@ -14,6 +16,55 @@ public function testDownload(): void
         $client = static::getClient();
         $this->injectFakeFileSystemManager();
 
+        $book = $this->findByIdAndKobo(BookFixture::ID, $this->getKoboDevice());
+        self::assertNotNull($book, 'The book is not linked to the Kobo');
+
+        /** @var DownloadHelper $downloadHelper */
+        $downloadHelper = self::getContainer()->get(DownloadHelper::class);
+
+        self::assertTrue($downloadHelper->exists($book), 'The book file does not exist');
+
+        $client?->request('GET', sprintf('/kobo/%s/v1/download/%s.%s', $this->accessKey, BookFixture::ID, 'epub'));
+
+        self::assertResponseIsSuccessful();
+        self::assertResponseHeaderSame('Content-Type', 'application/epub+zip');
+        self::assertResponseHasHeader('Content-Length');
+        $expectedDisposition = "attachment; filename=book-1-TheOdysses.epub; filename*=utf-8''TheOdysses.epub";
+        self::assertResponseHeaderSame('Content-Disposition', $expectedDisposition, 'The Content-Disposition header is not as expected');
+
+    }
+
+    public function testDownloadKepubFailed(): void
+    {
+        $client = static::getClient();
+        $this->injectFakeFileSystemManager();
+
+        // Disable Kepubify conversion
+        $lastValue = $this->getKepubifyEnabler()->disable();
+
+        try {
+            $book = $this->findByIdAndKobo(BookFixture::ID, $this->getKoboDevice());
+            self::assertNotNull($book, 'The book is not linked to the Kobo');
+
+            /** @var DownloadHelper $downloadHelper */
+            $downloadHelper = self::getContainer()->get(DownloadHelper::class);
+
+            self::assertTrue($downloadHelper->exists($book), 'The book file does not exist');
+
+
+            $client?->request('GET', sprintf('/kobo/%s/v1/download/%s.%s', $this->accessKey, BookFixture::ID, MetadataResponseService::KEPUB_FORMAT));
+            self::assertResponseStatusCodeSame(404); // We can not download kepub as the conversion is disabled
+        } finally {
+            // Re-enable Kepubify conversion for other tests
+            $this->getKepubifyEnabler()->setKepubifyBinary($lastValue);
+        }
+    }
+
+    public function testDownloadKepub(): void
+    {
+        $client = static::getClient();
+        $this->injectFakeFileSystemManager();
+
 
         $book = $this->findByIdAndKobo(BookFixture::ID, $this->getKoboDevice());
         self::assertNotNull($book, 'The book is not linked to the Kobo');
@@ -23,13 +74,13 @@ public function testDownload(): void
 
         self::assertTrue($downloadHelper->exists($book), 'The book file does not exist');
 
-        $client?->request('GET', sprintf('/kobo/%s/v1/download/%s.epub', $this->accessKey, BookFixture::ID));
+        $client?->request('GET', sprintf('/kobo/%s/v1/download/%s.'.MetadataResponseService::KEPUB_FORMAT, $this->accessKey, BookFixture::ID));
 
         self::assertResponseIsSuccessful();
         self::assertResponseHeaderSame('Content-Type', 'application/epub+zip');
         self::assertResponseHasHeader('Content-Length');
 
-        $expectedDisposition = "attachment; filename=book-1-TheOdysses.epub; filename*=utf-8''TheOdysses.epub";
+        $expectedDisposition = "attachment; filename=book-1-TheOdysses.kepub; filename*=utf-8''TheOdysses.kepub";
         self::assertResponseHeaderSame('Content-Disposition', $expectedDisposition, 'The Content-Disposition header is not as expected');
 
     }
@@ -38,4 +89,12 @@ private function findByIdAndKobo(int $bookId, KoboDevice $kobo): ?Book
     {
         return $this->getEntityManager()->getRepository(Book::class)->findByIdAndKoboDevice($bookId, $kobo);
     }
+
+    private function getKepubifyEnabler(): KepubifyEnabler
+    {
+        $service = self::getContainer()->get(KepubifyEnabler::class);
+        assert($service instanceof KepubifyEnabler);
+
+        return $service;
+    }
 }