Move getVerdicts to ConfigurationService

Also add some documentation.

Author: eldering

webapp/src/Controller/API/JudgementController.php

@@ -44,7 +44,7 @@ public function __construct(
     ) {
         parent::__construct($entityManager, $DOMJudgeService, $config, $eventLogService);
 
-        $this->verdicts = $this->dj->getVerdicts(['final', 'error']);
+        $this->verdicts = $this->config->getVerdicts(['final', 'error']);
     }
 
     /**

webapp/src/Controller/API/JudgementTypeController.php

@@ -85,7 +85,7 @@ public function singleAction(Request $request, string $id): JudgementType
      */
     protected function getJudgementTypes(?array $filteredOn = null): array
     {
-        $verdicts = $this->dj->getVerdicts(['final', 'external']);
+        $verdicts = $this->config->getVerdicts(['final', 'external']);
 
         $result = [];
         foreach ($verdicts as $name => $label) {

webapp/src/Controller/API/RunController.php

@@ -46,7 +46,7 @@ public function __construct(
         parent::__construct($entityManager, $DOMJudgeService, $config,
             $eventLogService);
 
-        $this->verdicts = $this->dj->getVerdicts();
+        $this->verdicts = $this->config->getVerdicts();
     }
 
     /**

webapp/src/Controller/Jury/RejudgingController.php

@@ -243,7 +243,7 @@ public function viewAction(
         $todo = $todoAndDone['todo'];
         $done = $todoAndDone['done'];
 
-        $verdicts = $this->dj->getVerdicts(['final', 'error']);
+        $verdicts = $this->config->getVerdicts(['final', 'error']);
         $verdicts[''] = 'JE'; /* happens for aborted judgings */
 
         $used         = [];

webapp/src/Controller/Jury/ShadowDifferencesController.php

@@ -83,7 +83,7 @@ public function indexAction(
         $this->requestStack->getSession()->save();
 
         $contest  = $this->dj->getCurrentContest();
-        $verdicts = $this->dj->getVerdicts(['final', 'error', 'external', 'in_progress']);
+        $verdicts = $this->config->getVerdicts(['final', 'error', 'external', 'in_progress']);
 
         $used         = [];
         $verdictTable = [];

webapp/src/Controller/Jury/SubmissionController.php

@@ -138,7 +138,7 @@ public function indexAction(
         // Load preselected filters
         $filters = Utils::jsonDecode((string)$this->dj->getCookie('domjudge_submissionsfilter') ?: '[]');
 
-        $results = array_keys($this->dj->getVerdicts(['final', 'in_progress']));
+        $results = array_keys($this->config->getVerdicts(['final', 'in_progress']));
 
         $data = [
             'refresh' => $refresh,

webapp/src/Form/Type/RejudgingType.php

@@ -107,7 +107,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 ->orderBy('j.hostname'),
         ]);
 
-        $verdicts = array_keys($this->dj->getVerdicts());
+        $verdicts = array_keys($this->config->getVerdicts());
         $builder->add('verdicts', ChoiceType::class, [
             'label' => 'Verdict',
             'multiple' => true,

webapp/src/Form/Type/SubmissionsFilterType.php

@@ -115,7 +115,7 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             "attr" => ["data-filter-field" => "team-id"],
         ]);
 
-        $verdicts = array_keys($this->dj->getVerdicts(['final', 'error', 'in_progress']));
+        $verdicts = array_keys($this->config->getVerdicts(['final', 'error', 'in_progress']));
         $builder->add("result", ChoiceType::class, [
             "label" => "Filter on result(s)",
             "multiple" => true,

webapp/src/Service/ConfigurationService.php

@@ -399,6 +399,41 @@ public function addOptions(ConfigurationSpecification $item): ConfigurationSpeci
         return $item;
     }
 
+    /**
+     * Returns all possible judgement (run) verdicts, both internally
+     * hardcoded and from configured judgement types. Depending on the
+     * requirements of the context, the following groups of verdicts can be
+     * requests:
+     * - final: final verdicts supported by the system
+     * - error: error states that must be resolved by an admin
+     * - in_progress: states reported when a judging is pending a final verdict
+     * - external: configured verdicts when importing from an external system
+     *
+     * Verdicts are returned as an associative array of name/2-3 letter
+     * identifier key/value pairs. The identifiers try to adhere to
+     * https://ccs-specs.icpc.io/draft/contest_api#known-judgement-types
+     *
+     * @return array<string, string>
+     */
+    public function getVerdicts(array $groups = ['final']): array
+    {
+        $verdictsConfig = $this->etcDir . '/verdicts.php';
+        $verdictGroups  = include $verdictsConfig;
+
+        $verdicts = [];
+        foreach( $groups as $group ) {
+            if ( $group === 'external' ) {
+                foreach ($this->get('external_judgement_types') as $id => $name) {
+                    $verdicts[$name] = $id;
+                }
+            } else {
+                $verdicts = array_merge($verdicts, $verdictGroups[$group]);
+            }
+        }
+
+        return $verdicts;
+    }
+
     public function getRunConfig(ContestProblem $problem, Submission $submission, int $overshoot = 0): string
     {
         $memoryLimit = $problem->getProblem()->getMemlimit();

webapp/src/Service/DOMJudgeService.php

@@ -1425,28 +1425,6 @@ public function parseMetadata(string $raw_metadata): array
         return $res;
     }
 
-    /**
-     * @return array<string, string>
-     */
-    public function getVerdicts(array $groups = ['final']): array
-    {
-        $verdictsConfig = $this->getDomjudgeEtcDir() . '/verdicts.php';
-        $verdictGroups  = include $verdictsConfig;
-
-        $verdicts = [];
-        foreach( $groups as $group ) {
-            if ( $group === 'external' ) {
-                foreach ($this->config->get('external_judgement_types') as $id => $name) {
-                    $verdicts[$name] = $id;
-                }
-            } else {
-                $verdicts = array_merge($verdicts, $verdictGroups[$group]);
-            }
-        }
-
-        return $verdicts;
-    }
-
     public function getScoreboardZip(
         Request $request,
         RequestStack $requestStack,