Add location to team API.

Fixes #2283.
Also rename room to location in database and UI to be more consistent.

Author: nickygerritsen

ChangeLog

@@ -27,6 +27,7 @@ Version 8.3.0DEV
  - Fix medal awards when skipping categories.
  - Add direct button to public page for registering when enabled.
  - Scale batch size of judge tasks dynamically.
+ - Rename room to location for teams.
 
 Version 8.2.0 - 6 March 2023
 ----------------------------

doc/manual/import.rst

@@ -166,7 +166,7 @@ fields:
 - ``display_name`` (optional): the team display name. If provided, will display
   this instead of the team name in certain places, like the scoreboard
 - ``organization_id``: the ID of the team affiliation this team belongs to
-- ``room`` (optional): the room of the team
+- ``location`` (optional): the location of the team
 
 If the ``data_source`` setting of DOMjudge is set to external, the ``id`` field will be the
 ID used for the team and the ``group_ids`` and ``organization_id`` fields are the values as
@@ -183,7 +183,7 @@ Example ``teams.json``::
     "group_ids": ["24"],
     "name": "¡i¡i¡",
     "organization_id": "INST-42",
-    "room": "AUD 10"
+    "location": "AUD 10"
   }, {
     "id": "2",
     "icpc_id": "447837",

webapp/migrations/Version20240112100916.php

@@ -0,0 +1,36 @@
+<?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 Version20240112100916 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Change room to location for teams.';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE team CHANGE room location VARCHAR(255) DEFAULT NULL COMMENT \'Physical location of team\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE team CHANGE location room VARCHAR(255) DEFAULT NULL COMMENT \'Physical location of team\'');
+    }
+
+    public function isTransactional(): bool
+    {
+        return false;
+    }
+}

webapp/public/js/domjudge.js

@@ -658,7 +658,7 @@ function updateMenuBalloons(data)
         $("#num-alerts-balloons").html(num);
         $("#num-alerts-balloons").show();
         for (var i=0; i<num; i++) {
-            var text = (data[i].room !== null) ? data[i].room+': ' : '';
+            var text = (data[i].location !== null) ? data[i].location+': ' : '';
             text += data[i].pname + ' ' + data[i].name;
             sendNotification('New balloon:',
                  {'tag': 'ball_' + data[i].baloonid,

webapp/src/Controller/Jury/BalloonController.php

@@ -91,10 +91,10 @@ public function indexAction(BalloonService $balloonService): Response
         if (isset($filters['location-str'])) {
             /** @var Team[] $filteredLocations */
             $filteredLocations = $this->em->createQueryBuilder()
-                ->from(Team::class, 'a', 'a.room')
+                ->from(Team::class, 'a', 'a.location')
                 ->select('a')
-                ->where('a.room IN (:rooms)')
-                ->setParameter('rooms', $filters['location-str'])
+                ->where('a.location IN (:locations)')
+                ->setParameter('locations', $filters['location-str'])
                 ->getQuery()
                 ->getResult();
         }

webapp/src/Controller/Jury/JuryMiscController.php

@@ -83,15 +83,15 @@ public function ajaxDataAction(Request $request, string $datatype): JsonResponse
             }, $affiliations);
         } elseif ($datatype === 'locations') {
             $locations = $qb->from(Team::class, 'a')
-                ->select('DISTINCT a.room')
-                ->where($qb->expr()->like('a.room', '?1'))
-                ->orderBy('a.room', 'ASC')
+                ->select('DISTINCT a.location')
+                ->where($qb->expr()->like('a.location', '?1'))
+                ->orderBy('a.location', 'ASC')
                 ->getQuery()->setParameter(1, '%' . $q . '%')
                 ->getResult();
 
             $results = array_map(fn(array $location) => [
-                'id' => $location['room'],
-                'text' => $location['room']
+                'id' => $location['location'],
+                'text' => $location['location']
             ], $locations);
         } elseif (!$this->isGranted('ROLE_JURY')) {
             throw new AccessDeniedHttpException('Permission denied');

webapp/src/Controller/Jury/TeamController.php

@@ -93,7 +93,7 @@ public function indexAction(): Response
             'affiliation' => ['title' => 'affiliation', 'sort' => true,],
             'num_contests' => ['title' => '# contests', 'sort' => true,],
             'ip_address' => ['title' => 'last IP', 'sort' => true,],
-            'room' => ['title' => 'room', 'sort' => true,],
+            'location' => ['title' => 'location', 'sort' => true,],
             'status' => ['title' => '', 'sort' => false,],
             'stats' => ['title' => 'stats', 'sort' => true,],
         ];

webapp/src/Controller/Team/MiscController.php

@@ -184,7 +184,7 @@ public function printAction(Request $request): Response
                 $teamId = (string)$team->getTeamid();
             }
             $ret  = $this->dj->printFile($realfile, $originalfilename, $langid,
-                $username, $team->getEffectiveName(), $teamId, $team->getRoom());
+                $username, $team->getEffectiveName(), $teamId, $team->getLocation());
 
             return $this->render('team/print_result.html.twig', [
                 'success' => $ret[0],

webapp/src/DataFixtures/Test/AddLocationToTeamFixture.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace App\DataFixtures\Test;
+
+use App\Entity\Team;
+use Doctrine\Persistence\ObjectManager;
+
+class AddLocationToTeamFixture extends AbstractTestDataFixture
+{
+    public function load(ObjectManager $manager): void
+    {
+        $team = $manager->getRepository(Team::class)->findOneBy(['name' => 'Example teamname']);
+        $team->setLocation('Utrecht');
+        $manager->flush();
+    }
+}

webapp/src/Entity/Team.php

@@ -87,8 +87,9 @@ class Team extends BaseApiEntity implements ExternalRelationshipEntityInterface,
     private ?string $publicDescription = null;
 
     #[ORM\Column(nullable: true, options: ['comment' => 'Physical location of team'])]
-    #[Serializer\Exclude]
-    private ?string $room = null;
+    #[OA\Property(nullable: true)]
+    #[Serializer\Groups([ARC::GROUP_NONSTRICT])]
+    private ?string $location = null;
 
     #[ORM\Column(
         name: 'internalcomments',
@@ -285,15 +286,15 @@ public function getPublicDescription(): ?string
         return $this->publicDescription;
     }
 
-    public function setRoom(?string $room): Team
+    public function setLocation(?string $location): Team
     {
-        $this->room = $room;
+        $this->location = $location;
         return $this;
     }
 
-    public function getRoom(): ?string
+    public function getLocation(): ?string
     {
-        return $this->room;
+        return $this->location;
     }
 
     public function setInternalComments(?string $comments): Team