Use RelTime for relative time fields in new API format, allow parsing it

Fixes #2946

Author: nickygerritsen

etc/db-config.yaml

@@ -350,12 +350,12 @@
             public: true
             description: If set, enable teams and jury to send source code to this command. See admin manual for allowed arguments.
             docdescription: See :ref:`printing` for more information.
-        -   name: event_feed_format
+        -   name: ccs_api_version
             type: enum
-            default_value: 2022-07
-            enum_class: App\Utils\EventFeedFormat
+            default_value: 2025-draft
+            enum_class: App\Utils\CcsApiVersion
             public: false
-            description: Format of the event feed to use. See [current draft](https://ccs-specs.icpc.io/draft/contest_api#event-feed) and [versions available](https://ccs-specs.icpc.io/).
+            description: Version of the CCS API to use for the API and event feed. See [current draft](https://ccs-specs.icpc.io/draft/contest_api#event-feed) and [versions available](https://ccs-specs.icpc.io/).
         -   name: shadow_mode
             type: bool
             default_value: false

webapp/migrations/Version20250706121413.php

@@ -0,0 +1,40 @@
+<?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 Version20250706121413 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Update `event_feed_format` config to `ccs_api_version`';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // Change key and values to the new format
+        $this->addSql('UPDATE configuration SET name = \'ccs_api_version\' WHERE name = \'event_feed_format\' AND value = \'"2020-03"\'');
+        $this->addSql('UPDATE configuration SET name = \'ccs_api_version\', value = \'"2023-06"\' WHERE name = \'event_feed_format\' AND value = \'"2022-07"\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // Change key and values back to the old format
+        $this->addSql('UPDATE configuration SET name = \'event_feed_format\' WHERE name = \'ccs_api_version\' AND value = \'"2020-03"\'');
+        $this->addSql('UPDATE configuration SET name = \'event_feed_format\', value = \'"2022-07"\' WHERE name = \'ccs_api_version\' AND value = \'"2023-06"\'');
+        // Delete it if we have a non-supported version
+        $this->addSql('DELETE FROM configuration WHERE name = \'ccs_api_version\'');
+    }
+
+    public function isTransactional(): bool
+    {
+        return false;
+    }
+}

webapp/src/Command/ImportEventFeedCommand.php

@@ -2,7 +2,6 @@
 
 namespace App\Command;
 
-use App\Controller\API\GeneralInfoController as GI;
 use App\Entity\Contest;
 use App\Entity\ExternalContestSource;
 use App\Entity\User;
@@ -53,7 +52,6 @@ protected function configure(): void
         $this
             ->setHelp(
                 'Import contest data from an event feed following the Contest API specification:' . PHP_EOL .
-                GI::CCS_SPEC_API_URL . ' or any version starting from "2021-11"' . PHP_EOL . PHP_EOL .
                 'Note the following assumptions and caveats:' . PHP_EOL .
                 '- Configuration data will only be verified.' . PHP_EOL .
                 '- Team members will not be imported.' . PHP_EOL .

webapp/src/Controller/API/ContestController.php

@@ -13,7 +13,7 @@
 use App\Service\DOMJudgeService;
 use App\Service\EventLogService;
 use App\Service\ImportExportService;
-use App\Utils\EventFeedFormat;
+use App\Utils\CcsApiVersion;
 use App\Utils\Utils;
 use BadMethodCallException;
 use Doctrine\Inflector\InflectorFactory;
@@ -648,7 +648,8 @@ public function getEventFeedAction(
             $since_id = -1;
         }
 
-        $format = $this->config->get('event_feed_format');
+        /** @var CcsApiVersion $format */
+        $format = $this->config->get('ccs_api_version');
 
         $response = new StreamedResponse();
         $response->headers->set('X-Accel-Buffering', 'no');
@@ -696,12 +697,16 @@ public function getEventFeedAction(
                 unset($toCheck['teamaffiliations']);
                 unset($toCheck['contestproblems']);
 
+                /** @var CcsApiVersion $ccsApiVersion */
+                $ccsApiVersion = $this->config->get('ccs_api_version');
+
                 foreach ($toCheck as $plural => $class) {
                     $serializerMetadata = $metadataFactory->getMetadataForClass($class);
                     /** @var PropertyMetadata $propertyMetadata */
                     foreach ($serializerMetadata->propertyMetadata as $propertyMetadata) {
                         if (is_array($propertyMetadata->groups) &&
-                            !in_array('Default', $propertyMetadata->groups)) {
+                            !in_array('Default', $propertyMetadata->groups) &&
+                            !in_array($ccsApiVersion->value, $propertyMetadata->groups)) {
                             $skippedProperties[$plural][] = $propertyMetadata->serializedName;
                         }
                     }
@@ -835,21 +840,25 @@ public function getEventFeedAction(
                             unset($data[$property]);
                         }
                     }
+
+                    $data = $this->eventLogService->applyCcsVersionChanges($event->getEndpointtype(), $data);
+
                     switch ($format) {
-                        case EventFeedFormat::Format_2020_03:
+                        case CcsApiVersion::Format_2020_03:
                             $result = [
                                 'id' => (string)$event->getEventid(),
-                                'type' => (string)$event->getEndpointtype(),
-                                'op' => (string)$event->getAction(),
+                                'type' => $event->getEndpointtype(),
+                                'op' => $event->getAction(),
                                 'data' => $data,
                             ];
                             break;
-                        case EventFeedFormat::Format_2022_07:
+                        case CcsApiVersion::Format_2023_06:
+                        case CcsApiVersion::Format_2025_DRAFT:
                             if ($event->getAction() === EventLogService::ACTION_DELETE) {
                                 $data = null;
                             }
-                            $id   = (string)$event->getEndpointid() ?: null;
-                            $type = (string)$event->getEndpointtype();
+                            $id   = $event->getEndpointid() ?: null;
+                            $type = $event->getEndpointtype();
                             if ($type === 'contests') {
                                 // Special case: the type for a contest is singular and the ID must not be set
                                 $id   = null;

webapp/src/Controller/API/GeneralInfoController.php

@@ -13,6 +13,7 @@
 use App\Service\DOMJudgeService;
 use App\Service\EventLogService;
 use App\Service\ImportProblemService;
+use App\Utils\CcsApiVersion;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\NonUniqueResultException;
 use Doctrine\ORM\NoResultException;
@@ -42,8 +43,6 @@ class GeneralInfoController extends AbstractFOSRestController
 {
     protected const API_VERSION = 4;
 
-    final public const CCS_SPEC_API_VERSION = '2023-06';
-    final public const CCS_SPEC_API_URL = 'https://ccs-specs.icpc.io/2023-06/contest_api';
 
     public function __construct(
         protected readonly EntityManagerInterface $em,
@@ -94,9 +93,12 @@ public function getInfoAction(
             );
         }
 
+        /** @var CcsApiVersion $ccsApiVersion */
+        $ccsApiVersion = $this->config->get('ccs_api_version');
+
         return new ApiInfo(
-            version: self::CCS_SPEC_API_VERSION,
-            versionUrl: self::CCS_SPEC_API_URL,
+            version: $ccsApiVersion->value,
+            versionUrl: $ccsApiVersion->getCcsSpecsApiUrl(),
             name: 'DOMjudge',
             //TODO: Add DOMjudge logo
             provider: new ApiInfoProvider(

webapp/src/Controller/API/ScoreboardController.php

@@ -13,13 +13,15 @@
 use App\Service\DOMJudgeService;
 use App\Service\EventLogService;
 use App\Service\ScoreboardService;
+use App\Utils\CcsApiVersion;
 use App\Utils\Scoreboard\Filter;
 use App\Utils\Utils;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\NonUniqueResultException;
 use FOS\RestBundle\Controller\Annotations as Rest;
 use Nelmio\ApiDocBundle\Attribute\Model;
 use OpenApi\Attributes as OA;
+use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
@@ -39,7 +41,7 @@ public function __construct(
         DOMJudgeService $DOMJudgeService,
         ConfigurationService $config,
         EventLogService $eventLogService,
-        protected readonly ScoreboardService $scoreboardService
+        protected readonly ScoreboardService $scoreboardService,
     ) {
         parent::__construct($entityManager, $DOMJudgeService, $config, $eventLogService);
     }
@@ -169,6 +171,8 @@ public function getScoreboardAction(
         }
 
         $scoreIsInSeconds = (bool)$this->config->get('score_in_seconds');
+        /** @var CcsApiVersion $ccsApiVersion */
+        $ccsApiVersion = $this->config->get('ccs_api_version');
 
         foreach ($scoreboard->getScores() as $teamScore) {
             if ($teamScore->team->getCategory()->getSortorder() !== $sortorder) {
@@ -183,10 +187,12 @@ public function getScoreboardAction(
             } else {
                 $score = new Score(
                     numSolved: $teamScore->numPoints,
-                    totalTime: $teamScore->totalTime,
+                    totalTime: $this->formatTime($teamScore->totalTime, $ccsApiVersion, $scoreIsInSeconds),
                 );
             }
 
+            $lastProblemTime = null;
+
             $problems = [];
             foreach ($scoreboard->getMatrix()[$teamScore->team->getTeamid()] as $problemId => $matrixItem) {
                 $contestProblem = $scoreboard->getProblems()[$problemId];
@@ -206,13 +212,19 @@ public function getScoreboardAction(
                 } else {
                     $problem->firstToSolve = $matrixItem->isCorrect && $scoreboard->solvedFirst($teamScore->team, $contestProblem);
                     if ($matrixItem->isCorrect) {
-                        $problem->time = Utils::scoretime($matrixItem->time, $scoreIsInSeconds);
+                        $problemTime = Utils::scoretime($matrixItem->time, $scoreIsInSeconds);
+                        $problem->time = $this->formatTime($problemTime, $ccsApiVersion, $scoreIsInSeconds);
+                        $lastProblemTime = max($lastProblemTime, $problemTime);
                     }
                 }
 
                 $problems[] = $problem;
             }
 
+            if ($lastProblemTime !== null) {
+                $score->time = $this->formatTime($lastProblemTime, $ccsApiVersion, $scoreIsInSeconds);
+            }
+
             usort($problems, fn(Problem $a, Problem $b) => $a->label <=> $b->label);
 
             $row = new Row(
@@ -227,4 +239,16 @@ public function getScoreboardAction(
 
         return $results;
     }
+
+    protected function formatTime(
+        int $time,
+        CcsApiVersion $ccsApiVersion,
+        bool $scoreIsInSeconds
+    ): int|string {
+        if ($ccsApiVersion->useRelTimes()) {
+            return $scoreIsInSeconds ? Utils::relTime($time) : Utils::relTime($time * 60);
+        } else {
+            return $time;
+        }
+    }
 }

webapp/src/Controller/Jury/JuryMiscController.php

@@ -16,6 +16,7 @@
 use App\Service\DOMJudgeService;
 use App\Service\EventLogService;
 use App\Service\ScoreboardService;
+use App\Utils\CcsApiVersion;
 use App\Utils\Utils;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Query\Expr\Join;
@@ -40,6 +41,7 @@ class JuryMiscController extends BaseController
     public function __construct(
         EntityManagerInterface $em,
         DOMJudgeService $dj,
+        protected readonly ConfigurationService $config,
         protected readonly EventLogService $eventLogService,
         protected readonly RequestStack $requestStack,
         KernelInterface $kernel,
@@ -63,9 +65,12 @@ public function indexAction(ConfigurationService $config): Response
             $this->addFlash('info', 'New release ' . $newestVersion . ' available at: https://www.domjudge.org/download.');
         }
 
+        /** @var CcsApiVersion $ccsApiVersion */
+        $ccsApiVersion = $this->config->get('ccs_api_version');
+
         return $this->render('jury/index.html.twig', [
             'adminer_enabled' => $config->get('adminer_enabled'),
-            'CCS_SPEC_API_URL' => GI::CCS_SPEC_API_URL,
+            'CCS_SPEC_API_URL' => $ccsApiVersion->getCcsSpecsApiUrl(),
         ]);
     }
 

webapp/src/DataTransferObject/Scoreboard/Problem.php

@@ -15,7 +15,7 @@ public function __construct(
         public readonly int $numPending,
         public readonly bool $solved,
         #[Serializer\Exclude(if: 'object.time === null')]
-        public ?int $time = null,
+        public int|string|null $time = null,
         #[Serializer\Groups([ARC::GROUP_NONSTRICT])]
         #[Serializer\Exclude(if: 'object.firstToSolve === null')]
         public ?bool $firstToSolve = null,

webapp/src/DataTransferObject/Scoreboard/Score.php

@@ -10,7 +10,9 @@ class Score
     public function __construct(
         public readonly int $numSolved,
         #[Serializer\Exclude(if: 'object.totalTime === null')]
-        public readonly ?int $totalTime = null,
+        public readonly int|string|null $totalTime = null,
+        #[Serializer\Exclude(if: 'object.time === null')]
+        public int|string|null $time = null,
         #[Serializer\Exclude(if: 'object.totalRuntime === null')]
         #[Serializer\Groups([ARC::GROUP_NONSTRICT])]
         public readonly ?int $totalRuntime = null,

webapp/src/DataTransferObject/Shadowing/ContestData.php

@@ -9,7 +9,7 @@ public function __construct(
         public readonly string $name,
         public readonly string $duration,
         public readonly ?string $scoreboardFreezeDuration,
-        public readonly int $penaltyTime,
+        public readonly int|string $penaltyTime,
         public readonly ?string $startTime,
         // TODO: check for end time and scoreboard thaw time
     ) {}