Fixes for kobo sync and proxy

.github/workflows/symfony.yml

@@ -5,7 +5,10 @@
 
 name: Tests
 
-on: [push,pull_request]
+on:
+  push:
+  pull_request:
+    types: [opened, reopened]
 
 permissions:
   contents: read

composer.json

@@ -135,6 +135,10 @@
       "Composer\\Config::disableProcessTimeout",
       "env XDEBUG_MODE=off ./vendor/bin/phpunit --colors=always"
     ],
+    "test-phpunit-xdebug": [
+      "Composer\\Config::disableProcessTimeout",
+      "env XDEBUG_MODE=debug XDEBUG_TRIGGER=1 ./vendor/bin/phpunit --colors=always"
+    ],
     "test": [
       "@test-phpcs",
       "@test-phpstan",

config/packages/monolog.yaml

@@ -1,8 +1,10 @@
 monolog:
     channels:
         - deprecation # Deprecations are logged in the dedicated "deprecation" channel when it exists
-        - proxy # Proxy logs are logged in the dedicated "proxy" channel when it exists
-        - kobo
+        - kobo_proxy # Proxy logs are logged in the dedicated "proxy" channel when it exists
+        - kobo_http # All request done on AbstractKoboController
+        - kobo_sync # Log specific to Sync endpoint
+        - kobo_kepubify # kepub conversion
 
 
     handlers:
@@ -16,10 +18,10 @@ monolog:
             type: console
             process_psr_3_messages: false
             channels: ["!event", "!doctrine"]
-        proxy:
+        kobo:
             type: rotating_file
             level: debug
-            channels: ["proxy","kobo"]
+            channels: ["kobo_proxy","kobo_http", "kobo_sync", "kobo_kepubify"]
             path: "%kernel.logs_dir%/kobo.%kernel.environment%.log"
             max_files: 10
 

config/packages/security.yaml

@@ -50,7 +50,7 @@ security:
     # Easy way to control access for large sections of your site
     # Note: Only the *first* access control that matches will be used
     access_control:
-        - { path: ^/api/v3/content/checkforchanges, roles: PUBLIC_ACCESS }
+        - { path: ^/api/v3/content/, roles: PUBLIC_ACCESS }
         - { path: ^/login, roles: PUBLIC_ACCESS }
         - { path: ^/logout, roles: ROLE_USER }
         - { path: ^/, roles: ROLE_USER }

config/services.yaml

@@ -16,6 +16,8 @@ parameters:
     KOBO_IMAGE_API_URL:  '%env(KOBO_IMAGE_API_URL)%'
     env(KEPUBIFY_BIN): "/usr/bin/kepubify"
     KEPUBIFY_BIN:  '%env(KEPUBIFY_BIN)%'
+    KOBO_READINGSERVICES_URL: '%env(bool:KOBO_READINGSERVICES_URL)%'
+    env(KOBO_READINGSERVICES_URL): 'https://readingservices.kobo.com'
 services:
     # default configuration for services in *this* file
     _defaults:
@@ -98,6 +100,7 @@ services:
     App\Kobo\Proxy\KoboProxyConfiguration:
       calls:
         - [ setStoreApiUrl, ['%KOBO_API_URL%'] ]
+        - [ setReadingServiceUrl, ['%KOBO_READINGSERVICES_URL%'] ]
         - [ setImageApiUrl, ['%KOBO_IMAGE_API_URL%'] ]
         - [ setEnabled, ['%KOBO_PROXY_ENABLED%'] ]
         - [ setUseProxyEverywhere, ['%KOBO_PROXY_USE_EVERYWHERE%'] ]
@@ -110,6 +113,10 @@ services:
         tags:
         - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 101 }
 
+    App\Kobo\LogProcessor\KoboContextProcessor:
+        tags:
+            - { name: monolog.processor }
+
 when@dev:
     services:
         Symfony\Component\HttpKernel\Profiler\Profiler: '@profiler'

migrations/Version20241129185216.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20241129185216 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add upstream_sync on koboDevice';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE kobo_device ADD upstream_sync TINYINT(1) DEFAULT 0 NOT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE kobo_device DROP upstream_sync');
+    }
+}

src/Controller/Kobo/AbstractKoboController.php

@@ -4,6 +4,6 @@
 
 use App\Controller\AbstractController;
 
-class AbstractKoboController extends AbstractController
+abstract class AbstractKoboController extends AbstractController
 {
 }

src/Controller/Kobo/Api/ApiEndpointController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Controller\Kobo\Api;
+
+use App\Controller\Kobo\AbstractKoboController;
+use App\Kobo\Proxy\KoboStoreProxy;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+#[Route('/kobo/{accessKey}', name: 'kobo_')]
+class ApiEndpointController extends AbstractKoboController
+{
+    public function __construct(
+        protected KoboStoreProxy $koboStoreProxy,
+    ) {
+    }
+
+    #[Route('/', name: 'api_endpoint')]
+    public function index(): Response
+    {
+        return new Response('<html><body>Hello Kobo</body></html>');
+    }
+}

src/Controller/Kobo/KoboImageController.php → src/Controller/Kobo/Api/ImageController.php

@@ -1,7 +1,8 @@
 <?php
 
-namespace App\Controller\Kobo;
+namespace App\Controller\Kobo\Api;
 
+use App\Controller\Kobo\AbstractKoboController;
 use App\Entity\Book;
 use App\Entity\KoboDevice;
 use App\Kobo\DownloadHelper;
@@ -19,8 +20,8 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 
-#[Route('/kobo/{accessKey}', name: 'kobo')]
-class KoboImageController extends AbstractKoboController
+#[Route('/kobo/{accessKey}', name: 'kobo_')]
+class ImageController extends AbstractKoboController
 {
     public function __construct(
         protected KoboDeviceRepository $koboRepository,

src/Controller/Kobo/KoboAnalyticsController.php → src/Controller/Kobo/Api/V1/AnalyticsController.php

@@ -1,7 +1,8 @@
 <?php
 
-namespace App\Controller\Kobo;
+namespace App\Controller\Kobo\Api\V1;
 
+use App\Controller\Kobo\AbstractKoboController;
 use App\Entity\KoboDevice;
 use App\Kobo\Proxy\KoboProxyConfiguration;
 use App\Kobo\Proxy\KoboStoreProxy;
@@ -14,8 +15,8 @@
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\Routing\Attribute\Route;
 
-#[Route('/kobo/{accessKey}', name: 'kobo')]
-class KoboAnalyticsController extends AbstractKoboController
+#[Route('/kobo/{accessKey}/v1/analytics', name: 'kobo_')]
+class AnalyticsController extends AbstractKoboController
 {
     public function __construct(
         protected KoboProxyConfiguration $koboProxyConfiguration,
@@ -30,7 +31,7 @@ public function __construct(
      * @throws GuzzleException
      * @throws \JsonException
      */
-    #[Route('/v1/analytics/gettests', methods: ['POST', 'GET'])]
+    #[Route('/gettests', methods: ['POST', 'GET'])]
     public function analyticsTests(Request $request): Response
     {
         $content = $request->getContent();
@@ -50,7 +51,7 @@ public function analyticsTests(Request $request): Response
      * @throws \JsonException
      * @throws GuzzleException
      */
-    #[Route('/v1/analytics/event', methods: ['POST'])]
+    #[Route('/event', methods: ['POST'])]
     public function analyticsEvent(Request $request, KoboDevice $kobo): Response
     {
         // Save the device_id and model

src/Controller/Kobo/KoboDownloadController.php → src/Controller/Kobo/Api/V1/DownloadController.php

@@ -1,29 +1,26 @@
 <?php
 
-namespace App\Controller\Kobo;
+namespace App\Controller\Kobo\Api\V1;
 
+use App\Controller\Kobo\AbstractKoboController;
 use App\Entity\Book;
 use App\Entity\KoboDevice;
 use App\Kobo\DownloadHelper;
-use App\Kobo\Proxy\KoboStoreProxy;
 use App\Repository\BookRepository;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
-#[Route('/kobo/{accessKey}', name: 'app_kobo')]
-class KoboDownloadController extends AbstractKoboController
+#[Route('/kobo/{accessKey}/v1/download', name: 'kobo_')]
+class DownloadController extends AbstractKoboController
 {
     public function __construct(
         protected BookRepository $bookRepository,
         protected DownloadHelper $downloadHelper,
-        protected KoboStoreProxy $koboStoreProxy,
-        protected LoggerInterface $logger)
-    {
+    ) {
     }
 
-    #[Route('/v1/download/{id}.{extension}', name: 'download', requirements: ['bookId' => '\d+', 'extension' => '[A-Za-z0-9]+'], methods: ['GET'])]
+    #[Route('/{id}.{extension}', name: 'download', requirements: ['bookId' => '\d+', 'extension' => '[A-Za-z0-9]+'], methods: ['GET'])]
     public function download(KoboDevice $kobo, Book $book, string $extension): Response
     {
         $this->assertCanDownload($kobo, $book);

src/Controller/Kobo/Api/V1/GenericController.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace App\Controller\Kobo\Api\V1;
+
+use App\Controller\Kobo\AbstractKoboController;
+use App\Kobo\Proxy\KoboStoreProxy;
+use GuzzleHttp\Exception\GuzzleException;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+
+#[Route('/kobo/{accessKey}/v1', name: 'kobo_')]
+class GenericController extends AbstractKoboController
+{
+    public function __construct(
+        protected KoboStoreProxy $koboStoreProxy,
+    ) {
+    }
+
+    /**
+     * @throws GuzzleException
+     */
+    #[Route('/user/loyalty/benefits')]
+    public function benefits(Request $request): Response
+    {
+        if ($this->koboStoreProxy->isEnabled()) {
+            return $this->koboStoreProxy->proxyOrRedirect($request);
+        }
+
+        return new JsonResponse(['Benefits' => new \stdClass()]);
+    }
+
+    /**
+     * @throws GuzzleException
+     */
+    #[Route('/affiliate', methods: ['GET', 'POST'])] // ?PlatformID=00000000-0000-0000-0000-000000000384&SerialNumber=xxxxxxx
+    #[Route('/assets', methods: ['GET'])]
+    #[Route('/deals', methods: ['GET', 'POST'])]
+    #[Route('/products', methods: ['GET', 'POST'])]
+    #[Route('/products/books/external/{uuid}', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/books/series/{uuid}', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/books/{uuid}', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/books/{uuid}/', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/books/{uuid}/access', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/dailydeal', methods: ['GET', 'POST'])]
+    #[Route('/products/deals', methods: ['GET', 'POST'])]
+    #[Route('/products/featured/', methods: ['GET', 'POST'])]
+    #[Route('/products/featured/{uuid}', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/{uuid}/prices', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/products/{uuid}/recommendations', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/user/recommendations/feedback', methods: ['GET', 'POST'])]
+    #[Route('/products/{uuid}/reviews', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/user/profile')]
+    #[Route('/configuration')]
+    #[Route('/auth/device')]
+    #[Route('/auth/refresh')]
+    #[Route('/library/borrow')]
+    #[Route('/auth/exchange')]
+    #[Route('/library/{uuid}', methods: ['DELETE'])]
+    #[Route('/user/recommendations', requirements: ['uuid' => '^[a-zA-Z0-9\-]+$'], methods: ['GET', 'POST'])]
+    #[Route('/user/wishlist')] // ?PageSize=100&PageIndex=0
+    public function proxy(Request $request, LoggerInterface $koboLogger): Response
+    {
+        $koboLogger->info('Kobo API Proxy request on '.$request->getPathInfo(), ['request' => $request->getContent(), 'headers' => $request->headers->all()]);
+
+        return $this->koboStoreProxy->proxyOrRedirect($request);
+    }
+}