Use enum for submission source

Author: nickygerritsen

webapp/src/Controller/API/SubmissionController.php

@@ -9,6 +9,7 @@
 use App\Entity\Language;
 use App\Entity\Submission;
 use App\Entity\SubmissionFile;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\User;
 use App\Service\ConfigurationService;
@@ -331,7 +332,7 @@ public function addSubmissionAction(
         // Now submit the solution.
         $submission = $this->submissionService->submitSolution(
             $team, $user, $problem, $problem->getContest(), $language,
-            $files, 'API', null, null, $entryPoint, $submissionId, $time, $message
+            $files, SubmissionSource::API, null, null, $entryPoint, $submissionId, $time, $message
         );
 
         // Clean up temporary if needed.

webapp/src/Controller/BaseController.php

@@ -10,7 +10,6 @@
 use App\Entity\ExternalIdFromInternalIdInterface;
 use App\Entity\Problem;
 use App\Entity\RankCache;
-use App\Entity\ScoreboardType;
 use App\Entity\ScoreCache;
 use App\Entity\Team;
 use App\Entity\TeamCategory;
@@ -168,8 +167,9 @@ protected function getDatabaseRelations(array $files): array {
             $parts = explode('/', $file);
             $shortClass = str_replace('.php', '', $parts[count($parts) - 1]);
             $class = sprintf('App\\Entity\\%s', $shortClass);
-            if (class_exists($class) && !in_array($class,
-                    [RankCache::class, ScoreCache::class, BaseApiEntity::class, ScoreboardType::class])) {
+            if (class_exists($class) &&
+                !in_array($class, [RankCache::class, ScoreCache::class, BaseApiEntity::class]) &&
+                !enum_exists($class)) {
                 $metadata = $this->em->getClassMetadata($class);
 
                 $tableRelations = [];

webapp/src/Controller/Jury/SubmissionController.php

@@ -17,6 +17,7 @@
 use App\Entity\Problem;
 use App\Entity\Submission;
 use App\Entity\SubmissionFile;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\TeamAffiliation;
 use App\Entity\TeamCategory;
@@ -1014,7 +1015,7 @@ public function editSourceAction(Request $request, Submission $submission, #[Map
                 $submission->getContest(),
                 $language,
                 $filesToSubmit,
-                'edit/resubmit',
+                SubmissionSource::EDIT_RESUBMIT,
                 $this->getUser()->getUserIdentifier(),
                 $submission->getOriginalSubmission() ?? $submission,
                 $entryPoint,

webapp/src/Controller/Team/SubmissionController.php

@@ -7,6 +7,7 @@
 use App\Entity\Language;
 use App\Entity\Problem;
 use App\Entity\Submission;
+use App\Entity\SubmissionSource;
 use App\Entity\Testcase;
 use App\Form\Type\SubmitProblemType;
 use App\Service\ConfigurationService;
@@ -84,7 +85,7 @@ public function createAction(Request $request, ?Problem $problem = null): Respon
                 }
                 $entryPoint = $form->get('entry_point')->getData() ?: null;
                 $submission = $this->submissionService->submitSolution(
-                    $team, $this->dj->getUser(), $problem->getProbid(), $contest, $language, $files, 'team page', null,
+                    $team, $this->dj->getUser(), $problem->getProbid(), $contest, $language, $files, SubmissionSource::TEAM_PAGE, null,
                     null, $entryPoint, null, null, $message
                 );
 

webapp/src/Entity/SubmissionSource.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace App\Entity;
+
+enum SubmissionSource: string
+{
+    case API = 'API';
+    case EDIT_RESUBMIT = 'edit/resubmit';
+    case PROBLEM_IMPORT = 'problem import';
+    case SHADOWING = 'shadowing';
+    case TEAM_PAGE = 'team page';
+    case UNKNOWN = 'unknown';
+
+}

webapp/src/Service/ExternalContestSourceService.php

@@ -30,6 +30,7 @@
 use App\Entity\Language;
 use App\Entity\Problem;
 use App\Entity\Submission;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\TeamAffiliation;
 use App\Entity\TeamCategory;
@@ -1551,7 +1552,7 @@ protected function importSubmission(Event $event, EventData $data): void
                 contest: $contest,
                 language: $language,
                 files: $filesToSubmit,
-                source: 'shadowing',
+                source: SubmissionSource::SHADOWING,
                 entryPoint: $entryPoint,
                 externalId: $submissionId,
                 submitTime: $submitTime,

webapp/src/Service/ImportProblemService.php

@@ -11,6 +11,7 @@
 use App\Entity\ProblemAttachmentContent;
 use App\Entity\ProblemStatementContent;
 use App\Entity\Submission;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\Testcase;
 use App\Entity\TestcaseContent;
@@ -757,7 +758,7 @@ public function importZippedProblem(
                             ]
                         );
                         $submission     = $this->submissionService->submitSolution(
-                            $team, $jury_user, $contestProblem, $contest, $languageToUse, $filesToSubmit, 'problem import', null,
+                            $team, $jury_user, $contestProblem, $contest, $languageToUse, $filesToSubmit, SubmissionSource::PROBLEM_IMPORT, null,
                             null, $entry_point, null, null, $submissionMessage
                         );
 

webapp/src/Service/SubmissionService.php

@@ -11,6 +11,7 @@
 use App\Entity\Problem;
 use App\Entity\Submission;
 use App\Entity\SubmissionFile;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\User;
 use App\Utils\FreezeData;
@@ -438,7 +439,7 @@ public function submitSolution(
         Contest|int $contest,
         Language|string $language,
         array $files,
-        ?string $source = null,
+        SubmissionSource $source = SubmissionSource::UNKNOWN,
         ?string $juryMember = null,
         Submission|int|null $originalSubmission = null,
         ?string $entryPoint = null,
@@ -569,7 +570,7 @@ public function submitSolution(
 
         if (!empty($entryPoint) && !preg_match(self::FILENAME_REGEX, $entryPoint)) {
             $message = sprintf("Entry point '%s' contains illegal characters.", $entryPoint);
-            if ($forceImportInvalid || $source === 'shadowing') {
+            if ($forceImportInvalid || $source === SubmissionSource::SHADOWING) {
                 $importError = $message;
             } else {
                 return null;
@@ -610,15 +611,15 @@ public function submitSolution(
             }
             if (!preg_match(self::FILENAME_REGEX, $file->getClientOriginalName())) {
                 $message = sprintf("Illegal filename '%s'.", $file->getClientOriginalName());
-                if ($forceImportInvalid || $source === 'shadowing') {
+                if ($forceImportInvalid || $source === SubmissionSource::SHADOWING) {
                     $importError = $message;
                 } else {
                     return null;
                 }
             }
             $totalSize += $file->getSize();
 
-            if ($source !== 'shadowing' && $language->getFilterCompilerFiles()) {
+            if ($source !== SubmissionSource::SHADOWING && $language->getFilterCompilerFiles()) {
                 $matchesExtension = false;
                 foreach ($language->getExtensions() as $extension) {
                     if (str_ends_with($file->getClientOriginalName(), '.' . $extension)) {
@@ -632,7 +633,7 @@ public function submitSolution(
             }
         }
 
-        if ($source !== 'shadowing' && $language->getFilterCompilerFiles() && $extensionMatchCount === 0) {
+        if ($source !== SubmissionSource::SHADOWING && $language->getFilterCompilerFiles() && $extensionMatchCount === 0) {
             $message = sprintf(
                 "None of the submitted files match any of the allowed " .
                 "extensions for %s (allowed: %s)",
@@ -647,7 +648,7 @@ public function submitSolution(
 
         if ($totalSize > $sourceSize * 1024) {
             $message = sprintf("Submission file(s) are larger than %d kB.", $sourceSize);
-            if ($forceImportInvalid || $source === 'shadowing') {
+            if ($forceImportInvalid || $source === SubmissionSource::SHADOWING) {
                 $importError = $message;
             } else {
                 return null;
@@ -660,7 +661,7 @@ public function submitSolution(
         // SQL transaction time below.
         // Only do this for problem import submissions, as we do not want this for re-submitted submissions nor
         // submissions that come through the API, e.g. when doing a replay of an old contest.
-        if ($this->dj->checkrole('jury') && $source == 'problem import') {
+        if ($this->dj->checkrole('jury') && $source === SubmissionSource::PROBLEM_IMPORT) {
             $results = null;
             foreach ($files as $file) {
                 $fileResult = self::getExpectedResults(file_get_contents($file->getRealPath()),
@@ -726,7 +727,7 @@ public function submitSolution(
             $this->em->flush();
 
             $this->dj->maybeCreateJudgeTasks($judging,
-                $source === 'problem import' ? JudgeTask::PRIORITY_LOW : JudgeTask::PRIORITY_DEFAULT);
+                $source === SubmissionSource::PROBLEM_IMPORT ? JudgeTask::PRIORITY_LOW : JudgeTask::PRIORITY_DEFAULT);
         }
 
         $this->em->wrapInTransaction(function () use ($contest, $submission) {
@@ -755,7 +756,7 @@ public function submitSolution(
                                            $language->getLangid(), $problem->getProblem()->getProbid()));
 
         $this->dj->auditlog('submission', $submission->getSubmitid(), 'added',
-            'via ' . ($source ?? 'unknown'), null, $contest->getCid());
+            'via ' . $source->value, null, $contest->getCid());
 
         if (Utils::difftime((float)$contest->getEndtime(), $submitTime) <= 0) {
             $this->logger->info(

webapp/tests/Unit/Controller/Jury/QueueTaskControllerTest.php

@@ -10,6 +10,7 @@
 use App\Entity\Problem;
 use App\Entity\QueueTask;
 use App\Entity\Submission;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Service\ConfigurationService;
 use App\Service\DOMJudgeService;
@@ -196,7 +197,7 @@ protected function addSubmission(string $team, string $problem): Submission
         return $this->submissionService->submitSolution(
             $team, null, $problem, $contest, 'c',
             [new UploadedFile(__FILE__, "foo.c", null, null, true)],
-            null, null, null, null, null, null, $msg
+            SubmissionSource::UNKNOWN, null, null, null, null, null, $msg
         );
     }
 

webapp/tests/Unit/Integration/QueuetaskIntegrationTest.php

@@ -7,6 +7,7 @@
 use App\Entity\JudgeTask;
 use App\Entity\Problem;
 use App\Entity\QueueTask;
+use App\Entity\SubmissionSource;
 use App\Entity\Team;
 use App\Entity\TeamCategory;
 use App\Entity\Testcase;
@@ -157,7 +158,7 @@ protected function setUp(): void
         self::getContainer()->get('security.untracked_token_storage')->setToken($token);
     }
 
-    private function submit(?float $time, ?Team $team = null, ?Problem $problem = null, string $source = 'team page'): QueueTask
+    private function submit(?float $time, ?Team $team = null, ?Problem $problem = null, SubmissionSource $source = SubmissionSource::TEAM_PAGE): QueueTask
     {
         $contest = $this->em->getRepository(Contest::class)->find($this->contest->getCid());
         $team ??= $this->teams[0];
@@ -323,15 +324,15 @@ public function testPriorities(): void
     {
         $time = Utils::now();
 
-        $normal = $this->submit($time, $this->teams[0], null, 'team page');
+        $normal = $this->submit($time, $this->teams[0], null, SubmissionSource::TEAM_PAGE);
         self::assertEquals((int)$time, $normal->getTeamPriority());
         self::assertEquals(JudgeTask::PRIORITY_DEFAULT, $normal->getPriority());
 
-        $api = $this->submit($time, $this->teams[1], null, 'api');
+        $api = $this->submit($time, $this->teams[1], null, SubmissionSource::API);
         self::assertEquals((int)$time, $api->getTeamPriority());
         self::assertEquals(JudgeTask::PRIORITY_DEFAULT, $api->getPriority());
 
-        $problem_import = $this->submit($time, $this->teams[2], null, 'problem import');
+        $problem_import = $this->submit($time, $this->teams[2], null, SubmissionSource::PROBLEM_IMPORT);
         self::assertEquals((int)$time, $problem_import->getTeamPriority());
         self::assertEquals(JudgeTask::PRIORITY_LOW, $problem_import->getPriority());
     }